Skip to main content

List Tenants

GET /tenants

List tenants.

Roles

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

GET /tenants/
Authorization: Bearer {your-auth-token}
Content-Type: application/json

Path Parameters

note

No path parameters.

Query Parameters

page_index Integer, Optional

Paged results page index (starting from 1).

  • Less than or equal to 10000.
  • Greater than or equal to 1.

page_limit Integer, Optional

Maximun number of results per page.

  • Less than or equal to 1000.
  • Greater than or equal to 1.

Request Headers

Refer to TenantRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

x-api-version String, Optional

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-request-id String

Request identifier.

  • Valid UUID.

Response Body

Refer to TenantListModel for more details.

current_limit Integer

Maximun number of results per page.

  • Less than or equal to 1000.
  • Greater than or equal to 1.

current_page Integer

Paged results page index (starting from 1).

  • Less than or equal to 10000.
  • Greater than or equal to 1.

results Array[TenantModel]

Refer to TenantModel.


total_count Integer

Paged results total viewable records.

  • Less than or equal to 100000.
  • Greater than or equal to 0.

total_pages Integer

Paged results total pages.

  • Less than or equal to 1000.
  • Greater than or equal to 0.

Code Samples

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
127.0.0.1:8003/tenants