GET
/
businesses
/
customers
/
{customerID}
Get Customer Businesses
curl --request GET \
  --url https://api.joinworth.com/case/api/v1/businesses/customers/{customerID} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Businesses associated with customer fetched successfully",
  "data": {
    "records": [
      {
        "id": "da790e45-7867-4419-b703-4a4687488fcb",
        "name": null,
        "tin": null,
        "address_apartment": null,
        "address_line_1": null,
        "address_line_2": null,
        "address_city": null,
        "address_state": null,
        "address_postal_code": null,
        "address_country": null,
        "created_at": "2023-12-22T11:03:04.416Z",
        "created_by": "e9d43901-3fc6-4ee9-97be-74cd23b39aa0",
        "updated_at": "2024-02-02T18:50:11.022Z",
        "updated_by": "e9d43901-3fc6-4ee9-97be-74cd23b39aa0",
        "mobile": null,
        "official_website": null,
        "public_website": null,
        "social_account": null,
        "status": "INACTIVE",
        "customer_id": "44aed0e8-89ec-4307-8b5d-310f8964e5b5",
        "external_id": "87654321"
      }
    ],
    "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
Examples:

"44aed0e8-89ec-4307-8b5d-310f8964e5b5"

Query Parameters

​
search_filter[external_id]
string

The unique external identifier provided during business creation. This can be a string or a UUID.

Examples:

"87654321"

"7fc4f7a1-e5e3-46ef-924e-595391585a45"

Response

200 - application/json; charset=utf-8

OK

The response is of type object.