v8

OpenAPI 3.1.02026-08-033623795.0 MB
Authorized users

List authorized users

Returns a paginated list of authorized team members for a company, with optional filtering by user, role, and creation date.

Required permissions:

  • company:authorized_user:read
  • member:email:read
get/authorized_users

Query parameters

afterstring nullable

Returns the elements in the list that come after the specified cursor.

beforestring nullable

Returns the elements in the list that come before the specified cursor.

firstinteger nullable

Returns the first n elements from the list.

Example:42
lastinteger nullable

Returns the last n elements from the list.

Example:42
company_idstring nullable

The unique identifier of the company to list authorized users for.

Example:biz_xxxxxxxxxxxxxx
user_idstring nullable

Filter results to a specific user to check if they are an authorized team member.

Example:user_xxxxxxxxxxxxx
role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'custom'

Possible roles an authorized user can have

created_beforestring date-time nullable

Only return authorized users created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable

Only return authorized users created after this timestamp.

Example:2023-12-01T05:00:00.401Z

Response

A successful response

Example response

{
  "data": [
    {
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      },
      "id": "ausr_xxxxxxxxxxxxx",
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ]
}