Skip to main content

ExternalUsersResponse

Response schema for multiple external users

data object[]required

A list of external users

  • Array [
  • emailstringnullablerequired

    The email address of the user at the provider.

    first_namestringnullablerequired

    The first name of the user at the provider.

    idstringrequired

    Unique identifier for the object.

    Possible values: Value must match regular expression ^exusr_\w{12}$

    last_namestringnullablerequired

    The last name of the user at the provider.

    objectstringrequired

    String representing the object's type.

    Possible values: [external_user]

    statusstringnullablerequired

    The status of the user at the provider. 'active' means the user is active, 'inactive' means the user is deactivated or suspended, 'pending' means the user has not yet activated their account. Additional values may be added over time.

    Possible values: [active, inactive, pending]

  • ]
  • meta objectrequired

    Metadata for paginated responses

    current_pageintegerrequired

    Current page number

    page_sizeintegerrequired

    Number of records per page

    total_countintegerrequired

    Total number of records

    total_pagesintegerrequired

    Total number of pages

    ExternalUsersResponse
    {
    "data": [
    {
    "email": "dr.smith@example.com",
    "first_name": "Jane",
    "id": "exusr_d025a96ac0c6",
    "last_name": "Smith",
    "object": "external_user",
    "status": "active"
    }
    ],
    "meta": {
    "current_page": 1,
    "page_size": 10,
    "total_count": 50,
    "total_pages": 5
    }
    }