Staff
Get a staff member
Returns a staff member by its identifier.
Request examples
curl https://app.filmo.io/api/v1/staff/staf_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
The projection is the same as the listing, and that is deliberate: the internal record carries personal and employment data —emergency contact, contract type and hours, internal and external cost, platform role— that is not published to an integrator. This operation exists to resolve an identifier without paginating the whole listing, not to widen what is seen of a person.
Authorizations
Bearer API key with the scope below. staff:read
Headers
Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Path parameters
Staff member identifier.
Limits: min length 1
Response
Successful response.
Response schema: StaffMemberDto
Envelope: StaffMemberResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Staff member, with the minimum projection needed for planning. Does NOT include contact, identity, employment or platform access data: see the resource documentation.
Show child attributesHide child attributes
Unique staff member identifier.
Full name.
Staff member type.
Available options: employee, freelancer, contractor
Identifier of the collection it belongs to; null if it is in none.
Collection path it belongs to; null if not applicable.
true if they hold a driving licence.
true if they appear in the planner of the account.
External reference for matching with third-party systems; null if it has none.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
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).
Not modified: the If-None-Match sent matches the current ETag. No body; the copy you have is current.
Headers: ETag
No body.
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
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
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
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
Staff member
Staff member, with the minimum projection needed for planning.
Was this page helpful?