Planner
List the assignable resources
The other half of the planner: /planner says what has to be covered and this one, with whom.
Request examples
curl 'https://app.filmo.io/api/v1/planner/resources?resourceType=staff' \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Returns the staff, the fleet or both. The date range is optional and goes as a pair; when you send it, the list is narrowed to the resources active in that window. It does not paginate.
Authorizations
Bearer API key with the scope below. planner:read
Query parameters
Which resources to list: staff, fleet or both.
Available options: staff, vehicle, both
Window start, in ISO 8601 with offset. Goes with endDate.
Window end, in ISO 8601 with offset. Goes with startDate.
Response
Successful response.
Response schema: PlannerResourceDto
Envelope: PlannerResourceItems. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Show child attributesHide child attributes
Resource identifier.
Name by which the resource is recognised.
Resource nature: staff or vehicle.
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
Planner resource
A resource that can cover a planner service.
Was this page helpful?