Sign in
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

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
user_idstring

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

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

Possible roles an authorized user can have

created_beforestring date-time

Only return authorized users created before this timestamp.

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

Only return authorized users created after this timestamp.

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

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

Example:biz_xxxxxxxxxxxxxx

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"
      }
    }
  ]
}

Changes

Changed in 4 of the 74 revisions of this API.1314

  • c19acf2e254811See the full diff
    • ●

      added the new partner enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value partner to the query request parameter role

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 697924df40d111See the full diff
    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f67a043e3190111See the full diff
    • ▲

      the query request parameter role was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value admin to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value advertiser to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value app_manager to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value custom to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value manager to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value moderator to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value owner to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value sales_manager to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value support to the query request parameter role

      request-parameter-enum-value-added

    • ○

      added the new enum value workforce to the query request parameter role

      request-parameter-enum-value-added

    • ○

      for the query request parameter role, the type was generalized from no type to string

      request-parameter-type-generalized

  • ae20b30817de11See the full diff
    • ●

      added the new workforce enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value workforce to the property oneOf[AuthorizedUserRoles]/ of the query request parameter role

      request-parameter-property-enum-value-added

Of the 74 revisions, 1 has no diff computed.