Account & access

User

A person with access to the account, with the role they hold in it.

Schemas: UserDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "email": "ana@example.com",
  "role": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "isAdmin": true,
  "status": "active",
  "staffMemberId": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A person with access to the account, with the role they hold, whether they administer it, the status of their access and the staff member they are linked to. Users are the people who sign in to Filmo, not the staff. No credentials, sessions, permissions or preferences are published, and only administrators can read them.

Attributes

idstring

Unique identifier of the user. It is the value other resources carry in createdBy, mentionedUserIds and the like.

namestring

Display name.

emailstring

Email the person signs in with.

roleobject

Role in this account.

Show child attributes

role.idstring

Identifier of the role: owner, super-admin, admin, a predefined role or custom.

role.namestring

Name of the role, in the language of the account.

isAdminboolean

true when the role administers the account.

statusstring

Access status: active, pending (invited, not yet accepted) or inactive.

Available options: active, pending, inactive

staffMemberIdstring | null

Identifier of the staff member this user is linked to (see /api/v1/staff); null if none.

createdAtstring<date-time> | null

Date the user account was created in ISO 8601 UTC; null for an invitation not yet accepted.

updatedAtstring<date-time> | null

Last modification date of the user account in ISO 8601 UTC; null for an invitation not yet accepted.

Values

status: active, pending, inactive

Returned by

GET /api/v1/users — List users

Modified by

No operation.

Was this page helpful?