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

Sample Request

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

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 360
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:43:27 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 7632547e-6f73-4e48-8303-856e520c74b1

{
"current_limit": 100,
"current_page": 1,
"results": [
  {
    "address": "123 some st",
    "city": "SMS City",
    "code": "SMSCORP",
    "created_on": "2022-08-20T01:10:52.307000",
    "email": "test_admin@smscorp.net",
    "id": 34,
    "is_active": true,
    "name": "SMS Corp",
    "phone": "1234567890",
    "state": "WA",
    "truck_limit": null,
    "zip": "98360"
  }
],
"total_count": 1,
"total_pages": 1
}

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

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

Python

import requests, json

response = requests.get(
  'http://localhost:8003/tenants',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json'
  },
  parameters={
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/tenants";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}