Internal services

Create an internal service

Schedules a working day that does not hang off an order: maintenance, transfer between warehouses, training.

POST

/api/v1/internal-services

curl https://app.filmo.io/api/v1/internal-services \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Mantenimiento de la flota",
  "serviceType": "fleet",
  "startDate": "2026-09-14T08:00:00+02:00",
  "endDate": "2026-09-14T14:00:00+02:00",
  "assignedVehicleIds": [
    "veh_sprinter_1"
  ],
  "qty": 1
}'

Node.jsfetch('https://app.filmo.io/api/v1/internal-services', { method: 'POST', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ title: 'Mantenimiento de la flota', serviceType: 'fleet', startDate: '2026-09-14T08:00:00+02:00', endDate: '2026-09-14T14:00:00+02:00', assignedVehicleIds: ['veh_sprinter_1'], qty: 1 }) })Pythonimport uuid import requests requests.post( "https://app.filmo.io/api/v1/internal-services", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "title": "Mantenimiento de la flota", "serviceType": "fleet", "startDate": "2026-09-14T08:00:00+02:00", "endDate": "2026-09-14T14:00:00+02:00", "assignedVehicleIds": [ "veh_sprinter_1" ], "qty": 1 } )

{
  "data": {
    "id": "internal_service_9f3a2b",
    "title": "Example title",
    "status": "Example status",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "projectId": "project_9f3a2b",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "internal-services:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

The MINIMUM duration is fifteen minutes. Returns the created internal service.

Authorizations

Bearer API key with the scope below. internal-services:write

Headers

Idempotency-Keystring

Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Body

application/json

Body schema: InternalServiceCreateBody

titlestringRequired

Assignment title.

Limits: min length 1

descriptionstring

Description of what needs to be done.

serviceIdstring

Catalogue service it comes from, if it comes from one.

serviceTypestring

Assignment type. Defaults to "crew".

Available options: crew, fleet, general

startDatestring<date-time>Required

Start in ISO 8601 with offset.

endDatestring<date-time>Required

End in ISO 8601 with offset. At least fifteen minutes after the start.

projectIdstring

Project it is charged to.

assignedStaffIdsstring[]

Assigned staff.

assignedVehicleIdsstring[]

Assigned vehicles.

qtyinteger

How many units of the service.

Limits: min 1

requirementsobject[]

Resources needed to provide it.

Show child attributes

requirements.requiredResourceTypestringRequired

What is needed: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtyintegerRequired

How many are needed.

Limits: min 1

Response

application/json

Successful response.

Response schema: InternalServiceDto

Envelope: InternalServiceResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Plannable assignment not attached to an order.

Show child attributes

data.idstring

Unique assignment identifier.

data.titlestring

Assignment title.

data.statusstring

Status: active, completed or cancelled.

data.startDatestring<date-time>

Start in ISO 8601 UTC.

data.endDatestring<date-time>

End in ISO 8601 UTC.

data.projectIdstring | null

Associated project; null if not applicable.

data.createdAtstring<date-time>

Creation date in ISO 8601 UTC.

data.updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
404	`not_found`	It does not exist or is outside the scope of the API key.
409	`conflict`	The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation.
412	`precondition_failed`	The `If-Match` entity tag does not match the current representation. Read the resource again and retry.
422	`idempotency_key_reused`	The same key was used before with a different body. Change the key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Operations
Internal service
Plannable assignment not attached to an order.

Was this page helpful?

Request examples

Authorizations

Headers

Body

Response

Errors

Deprecation

Related

Related pages

Internal service