Internal services
List internal services
Returns the plannable assignments not attached to an order, cursor-paginated.
Request examples
curl https://app.filmo.io/api/v1/internal-services \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Filter by status, type, project and an overlap window (overlapsFrom/overlapsTo: assignments whose period overlaps it). Sorted by start date. Creation and update date filters and filtering by assigned resource are not available on this listing.
Authorizations
Bearer API key with the scope below. internal-services:read
Query parameters
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: startDate, endDate, title, status, createdAt, updatedAt. Defaults to "startDate". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by status: active, completed or cancelled.
Available options: active, completed, cancelled
Filter by type: crew (personnel), fleet (vehicles) or general.
Available options: crew, fleet, general
Filter by associated project.
Limits: min length 1, max length 100
Start of the overlap window: returns assignments whose period overlaps [overlapsFrom, overlapsTo]. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
End of the overlap window: returns assignments whose period overlaps [overlapsFrom, overlapsTo]. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Response
Successful response.
Response schema: InternalServiceDto
Envelope: InternalServiceList. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Show child attributesHide child attributes
Unique assignment identifier.
Assignment title.
Status: active, completed or cancelled.
Start in ISO 8601 UTC.
End in ISO 8601 UTC.
Associated project; null if not applicable.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Opaque-cursor pagination metadata.
Show child attributesHide child attributes
Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.
Whether more results exist beyond this page.
Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.
Limits: min 0
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Invalid request (validation_error): malformed query or body. errors[] lists every offending field with its stable code.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
| Status | Codes | Meaning |
|---|---|---|
| 400 | validation_error | Malformed query or body. errors[] lists every offending field with its stable code. |
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
Related pages
Link to this section: Related pagesOperations
Internal service
Plannable assignment not attached to an order.
Was this page helpful?