Skip to main content
GET
/
businesses
/
customers
/
{customerID}
Get Customer Businesses
curl --request GET \
  --url https://api.joinworth.com/case/api/v1/businesses/customers/{customerID}
{
  "status": "success",
  "message": "Businesses associated with customer fetched successfully",
  "data": {
    "records": [
      {
        "id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d",
        "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": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d",
        "updated_at": "2024-02-02T18:50:11.022Z",
        "updated_by": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d",
        "mobile": null,
        "official_website": null,
        "public_website": null,
        "social_account": null,
        "status": "INACTIVE",
        "customer_id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d",
        "external_id": "87654321"
      }
    ],
    "total_pages": 1,
    "total_items": 1
  }
}

Path Parameters

customerID
string
required
Example:

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

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"

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

Response

200 - application/json; charset=utf-8

OK

status
string
message
string
data
Data2 · object