Skip to main content

List users

GET 

/users

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns a list of User objects.

Request

Query Parameters

    modified_after date-time

    If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format and URI encoded.

    Example: 2023-02-23T00:00:00Z
    page_size string

    Number of results to return per page. (Max: 1000)

    Example: 123
    cursor string

    The pagination cursor value

    Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Responses

UsersData

Schema
    pagination objectrequired
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    records object[]required
  • Array [
  • name stringnullablerequired
    email_address stringrequired
    is_active booleanrequired
    teams string[]
    avatar stringnullable
  • ]
Loading...