Planner

List the assignable resources

The other half of the planner: /planner/services says what has to be covered and this one, with whom.

GET
/api/v1/planner/resources

Request examples

curl 'https://app.filmo.io/api/v1/planner/resources?resourceType=staff' \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "planner_resource_9f3a2b",
      "name": "Example planner resource",
      "type": "Example type"
    }
  ]
}

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

resourceTypestringRequired

Which resources to list: staff, fleet or both.

Available options: staff, vehicle, both

startDatestring<date-time>

Window start, in ISO 8601 with offset. Goes with endDate.

endDatestring<date-time>

Window end, in ISO 8601 with offset. Goes with startDate.

Response

application/json

Successful response.

Response schema: PlannerResourceDto

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

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Resource identifier.

data.namestring

Name by which the resource is recognised.

data.typestring

Resource nature: staff or vehicle.

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.

Errors

StatusCodesMeaning
400validation_errorMalformed 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