GET
/
customers
/
{customerID}
/
users
curl --request GET \
  --url https://api.joinworth.com/auth/api/v1/customers/{customerID}/users \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Success",
  "data": {
    "records": [
      {
        "id": "94520740-d63c-4e02-85ca-c4e138801e73",
        "first_name": "Sandbox",
        "last_name": "CRO",
        "email": "dummy.customer.user@email.com",
        "mobile": null,
        "is_email_verified": false,
        "is_first_login": true,
        "created_at": "2024-02-12T14:16:49.053Z",
        "created_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
        "updated_at": "2024-02-12T14:16:49.053Z",
        "updated_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
        "ext_auth_ref_id": "ec46bd5b-0fae-47e1-8e4e-d37a5ac87e7e",
        "status": "INVITED",
        "subrole": {
          "id": "f1fa445c-743b-4a0e-ad54-bb9294c41005",
          "code": "cro",
          "display_name": "CRO",
          "label": "CRO",
          "description": "This is Sandbox's CRO"
        }
      }
    ],
    "total_pages": 1,
    "total_items": "1"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerID
string
required
Example:

"2e6438cb-ec3f-4e94-b5c9-8c058d2efaf1"

Response

200 - application/json; charset=utf-8
OK
​
status
string
required
​
message
string
required
​
data
object
required
Example:
{
  "records": [
    {
      "id": "94520740-d63c-4e02-85ca-c4e138801e73",
      "first_name": "Sandbox",
      "last_name": "CRO",
      "email": "dummy.customer.user@email.com",
      "mobile": null,
      "is_email_verified": false,
      "is_first_login": true,
      "created_at": "2024-02-12T14:16:49.053Z",
      "created_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
      "updated_at": "2024-02-12T14:16:49.053Z",
      "updated_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
      "ext_auth_ref_id": "ec46bd5b-0fae-47e1-8e4e-d37a5ac87e7e",
      "status": "INVITED",
      "subrole": {
        "id": "f1fa445c-743b-4a0e-ad54-bb9294c41005",
        "code": "cro",
        "display_name": "CRO",
        "label": "CRO",
        "description": "This is Sandbox's CRO"
      }
    }
  ],
  "total_pages": 1,
  "total_items": "1"
}

Was this page helpful?