List Users

GET /locations/{location_id}/users

List user profiles.

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 /locations/{location_id}/users/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

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: 744
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:44:58 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: af57dbf0-594a-4e48-b089-239087daa597

{
"current_limit": 100,
"current_page": 1,
"results": [
  {
    "dispatcher_id": null,
    "id": 100043,
    "roles": [
      "ThirdPartyDriver"
    ],
    "third_party_hauler_id": "571821f4-0079-4e0d-bd84-1dbe45fcd678",
    "uid": "9c941e76-36c8-46d2-abbf-f236284003fb",
    "username": "garett"
  },
  {
    "dispatcher_id": null,
    "id": 100025,
    "roles": [
      "ThirdPartyDriver"
    ],
    "third_party_hauler_id": "571821f4-0079-4e0d-bd84-1dbe45fcd678",
    "uid": "23b82438-feb9-4107-a0c5-17e7326f6288",
    "username": "test_3rd_party_driver_2027"
  },
  {
    "dispatcher_id": 9011,
    "id": 115,
    "roles": [
      "ThirdPartyDispatcher"
    ],
    "third_party_hauler_id": "571821f4-0079-4e0d-bd84-1dbe45fcd678",
    "uid": "b6f56cd1-d407-4b4a-b748-7ea629def384",
    "username": "test_3rd_party_provider_115"
  }
],
"total_count": 3,
"total_pages": 1
}

Path Parameters

location_id Integer, Required

Location identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel 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).

---

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

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 UserListResultsModel 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[UserModel]

Refer to UserModel.

---

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" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/locations/{location_id}/users

Python

import requests, json

response = requests.get(
  'http://localhost:8003/locations/{location_id}/users',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  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 = "/locations/{location_id}/users";

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

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