users

Requires at least one of the permissions audit:activity_log:read, customers:customer:read, sales:quote:create, settings:user:list, settings:user:read, users:user:read or visits:journey-plan:manage.

Lists the staff of your own organization, with optional filters. The organization always comes from the signed-in user; any organization ID you send is ignored. Needs the users read permission, or a permission whose screens name or pick colleagues (customers read, route planning, quote create, activity log read).

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Users {
  users {
    id
    postalCode
    name
    firstName
    lastName
    status
    directPermissions {
      id
      name
      createdAt
      action
      description
      direct
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Users {\n  users {\n    id\n    postalCode\n    name\n    firstName\n    lastName\n    status\n    directPermissions {\n      id\n      name\n      createdAt\n      action\n      description\n      direct\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "users": [
      {
        "id": "id",
        "postalCode": "string",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "status": "ACTIVE",
        "directPermissions": [
          {
            "id": "id",
            "name": "string",
            "createdAt": "2025-01-15T00:00:00Z",
            "action": "string",
            "description": "string",
            "direct": true
          }
        ]
      }
    ]
  }
}

users(
  filters: UserFilters
  organizationId: String
): [User!]!

Arguments

users.filters ● UserFilters input

Optional filters that narrow the users returned.

users.organizationId ● String scalar

Deprecated and ignored: the organization comes from the signed-in user. Kept optional so installed apps that still send it keep working.

Type

User object

A user of the organization.