Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
accounts
/
capacity
/
typeahead
Typeahead search on Accounts for a Company with with Capacity Data
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/accounts/capacity/typeahead \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "schedule_on": true,
      "current_assigned_count": 123,
      "current_capacity_count": 123,
      "connected_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "labels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tread.ai/llms.txt

Use this file to discover all available pages before exploring further.

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"

Path Parameters

company-id
string
required

Company ID

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[availability]
boolean

Filter based on record availability based on the date parameter/filter, defaulting to the current day.

filter[show_all]
boolean

Show all records. Deprecated in favor of filter[availability]

filter[label_ids]
string<uuid>[]

Filter by Label IDs. Returns records that have ANY of the specified labels (OR logic).

date
string
required

The date to query for regarding capacity. In YYYY-MM-DD format.

Response

OK

data
Account-Read-Capacity-Typeahead · object[]
required