Users

List users

Returns the people with access to the account — the ones who sign in to Filmo, not the staff — with their role, whether they administer the account, the status of their access (active, pending invitation or inactive) and the staff member they are linked to.

Tool

filmo_users_list

Readusers:read

users:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_users_list",
    "arguments": {
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "name": "Example",
        "email": "ana@example.com",
        "role": {
          "id": "id_8f2a1c",
          "name": "Example"
        },
        "isAdmin": true,
        "status": "active",
        "staffMemberId": "staf_8f2a1c",
        "createdAt": "2026-09-01T08:00:00Z",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

It emits no credentials, sessions, permissions or preferences. Administrators only. Sorted by name.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: name, email, status, createdAt, updatedAt. Defaults to "name". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

statusstring

Filter by access status: active, pending (invited, not yet accepted) or inactive.

Available options: active, pending, inactive

statusesstring[]

Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: active, pending, inactive

Limits: min 1 items, max 50 items

isAdminboolean

Filter by whether the user is an administrator of the account (true) or not (false).

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.

Show child attributes

dateFilters.createdobject

Show child attributes

dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes

dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

Exactly that day; an instant means the whole business day that contains it.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

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.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/users.

Users
List users
Returns the people with access to the account — the ones who sign in to Filmo, not the staff — with their role, whether they administer the account, the status of their access (active, pending invitation or inactive) and the staff member they are linked to.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List users

Safe writes

Errors