Staff

Create a staff member

Registers someone in the staff.

POST
/api/v1/staff

Request examples

curl https://app.filmo.io/api/v1/staff \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "Ana Ruiz",
  "staffType": "freelancer",
  "hasDrivingLicense": true,
  "tags": [
    "Eléctricos",
    "Madrid"
  ]
}'
{
  "data": {
    "id": "staff_member_9f3a2b",
    "fullName": "Example full name",
    "staffType": "employee",
    "collectionId": "collection_9f3a2b",
    "collectionName": "Example collection name",
    "hasDrivingLicense": true,
    "showInPlanner": true,
    "externalRef": "Example external ref",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generated from the schema

The body accepts ONLY the organizational part —name, relationship type, collection, tags and whether they drive—: email, phone and free text are personal data and do not travel through the public edge, just as they are not emitted on read. Returns the created member with the same projection as the listing.

Authorizations

Bearer API key with the scope below. staff:write

Headers

Idempotency-Keystring

Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Body

application/json

Body schema: StaffMemberCreateBody

fullNamestringRequired

Full name.

Limits: min length 2, max length 200

staffTypestring

Engagement type with the company.

Available options: employee, freelancer, contractor

collectionIdstring

Collection it belongs to.

Limits: min length 1

tagsstring[]

Tags by name; a name that does not exist CREATES the tag.

Limits: max 50 items, each max length 100

hasDrivingLicenseboolean

Whether they hold a driving licence. It is the field that decides who can drive a vehicle.

Response

application/json

Successful response.

Response schema: StaffMemberDto

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

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

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 attributes
data.idstring

Unique staff member identifier.

data.fullNamestring

Full name.

data.staffTypestring

Staff member type.

Available options: employee, freelancer, contractor

data.collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

data.collectionNamestring | null

Collection path it belongs to; null if not applicable.

data.hasDrivingLicenseboolean

true if they hold a driving licence.

data.showInPlannerboolean

true if they appear in the planner of the account.

data.externalRefstring | null

External reference for matching with third-party systems; null if it has none.

data.createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

data.updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

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.
404not_foundIt does not exist or is outside the scope of the API key.
409conflictThe current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (If-Match) held the resource for more than five seconds. errors[0].code says which: in_progress and lock_timeout are solved by retrying; invalid_state is not, because the state of the resource forbids the operation.
412precondition_failedThe If-Match entity tag does not match the current representation. Read the resource again and retry.
422idempotency_key_reusedThe same key was used before with a different body. Change the key.

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

  • Operations

    Staff member

    Staff member, with the minimum projection needed for planning.