Get users

Request

Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all.

Required permissions: users:read, users:list, apps:read, [appId]:read, apps:list, [appId]:list.

Security

ClientAccessToken

Query

searchstring

Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax

page_offsetnumber

Number of users you wish to skip before selecting users

page_limitnumber, <= 5000

Number of users to return in page

search_prefixstring

Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, "search_prefix=john" will return users whose email starts with "john" and "search_prefix=%2B1212" returns users whose phone number starts with "+1212".

Example:search_prefix=joe

sort_fieldstring

The name of the field you wish to sort by. Mgmt flows also support: organization_added_at (sort by when member was added to org)

Default:"created_at"

Enum:"email""created_at""phone_number""last_auth""organization_added_at"

sort_orderstring

The order of the sort

Default:"asc"

Enum:"asc""desc"

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users?search=string&page_offset=0&page_limit=5000&search_prefix=joe&sort_field=email&sort_order=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

total_countnumberrequired

page_infoobjectrequired

resultArray of objectsrequired

Response

{
  "total_count": 0,
  "page_info": {
    "has_next_page": true,
    "has_previous_page": true
  },
  "result": [
    { … }
  ]
}