Services
List services
Returns the sellable services of the catalogue, cursor-paginated: personnel, transport and work days that do not come from inventory, with their requirements and tags.
Request examples
curl https://app.filmo.io/api/v1/services \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Filter by type, collection and a single tag. Sorted by name; sort accepts a single field. Costs and the internal name are not published; creation and update date filters are not available on this listing.
Authorizations
Bearer API key with the scope below. 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: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: name, serviceType, defaultQty, createdAt, updatedAt. Defaults to "name". 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 type: crew (personnel), fleet (vehicles) or general.
Available options: crew, fleet, general
Filter by identifier of the collection the service belongs to.
Limits: min length 1, max length 100
Filter by collectionId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by tag identifier: services that carry that tag.
Limits: min length 1, max length 100
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: ServiceDto
Envelope: ServiceList. 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 service identifier.
Service name as the customer sees it.
Type: crew (personnel), fleet (vehicles) or general.
Description; null if it has none.
Quantity added to an order by default.
Whether it appears as a plannable service.
Whether its amount counts towards the document total.
Path of the collection it belongs to; null if it is in none.
Resources needed to provide it.
Show child attributesHide child attributes
What is needed to provide it: personnel or vehicle.
Available options: personnel, vehicle
How many are needed.
Limits: min 1
Tags the assigned resource must have. E.g.: "Carné C".
Limits: max 20 items, each max length 100
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
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
Service
Sellable line that does not come from inventory: personnel, transport, work days.
Was this page helpful?