Users

List users and their permissions

List all users in the account with their permissions.

Admin only. Returns 403 Forbidden unless the API key belongs to a user with settings_access of account_admin.

Results include active, deactivated, then pending members; page through with next_cursor, or filter with status. Invited users have no permissions object yet, and their created_at is the invite date.

get/users

Request

Base URL
https://api.fathom.ai/external/v1
URL
https://api.fathom.ai/external/v1/users
Auth
- API key in header X-Api-Key
- or HTTP bearer

Query parameters

cursorstring

Cursor for pagination.

teamstring

Team name to filter by.

status'active' | 'deactivated' | 'invited'

Filter by user status. invited cannot be combined with settings_access.

settings_access'none' | 'team_admin' | 'account_admin'

Filter by settings access level.

Response

Paginated list of users.

limitinteger required

next_cursorstring nullable required

Example response

{
  "items": [
    {
      "name": "Bob Lee",
      "email": "bob.lee@acme.com",
      "created_at": "2024-06-01T08:30:00Z",
      "permissions": {
        "settings_access": {
          "teams": [
            "Sales",
            "Customer Success"
          ]
        },
        "view_access": {
          "teams": [
            "Sales"
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.