Skip to main content
GET
/
v1
/
users
/
typeahead
Typeahead search on Users
curl --request GET \
  --url https://api.tread-horizon.com/v1/users/typeahead \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Query Parameters

​
page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
​
page[after]
string

The cursor to start paginating after

​
page[before]
string

The cursor to stop paginating at

​
search[query]
string

Search string for queries

​
filter[iam_roles]
array

The IamRoles of the User. Allowed values: platform_admin, company_admin, dispatcher, biller, foreman, driver, it_admin, manager

Response

OK

​
data
User-Read-Typeahead · object[]
required