Retrieve Customer Account

Learn about the customer account API that allows retrieval of customer account information. Accessible through the /api/v1/customer-accounts/{id}/ endpoint using the GET method, this API provides details in JSON format upon manager authorization.

Endpoint

  • Method: GET

  • URL: /api/v1/customer-accounts/{id}/

  • Description: Retrieves a single customer account, if requesting manager has access permissions to it.

Example successful response (200)

200
{
    "id": 811,
    "customers_count": 0,
    "code": "tc4",
    "name": "Test Customer Company 4",
    "description": "",
    "phone": "",
    "address": "",
    "email": "",
    "cognito_user_pool_id": "",
    "company": 339
}

Example not found response (404)

Was this helpful?