List Customer Accounts

{
  "name": "Show all customer accounts the requesting manager has access permissions to.",
  "method": "GET",
  "url": "/api/v1/customer-accounts/",
  "description": "",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "BC4AyNnqxv7gCFubd8Hwt",
        "language": "json",
        "code": "",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "BC4AyNnqxv7gCFubd8Hwt"
  },
  "results": {
    "languages": [
      {
        "id": "23j86a9viICroBOfXSY-U",
        "language": "200",
        "code": "{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 811,\n            \"customers_count\": 0,\n            \"code\": \"tc4\",\n            \"name\": \"Test Customer Company 4\",\n            \"description\": \"\",\n            \"phone\": \"\",\n            \"address\": \"\",\n            \"email\": \"\",\n            \"cognito_user_pool_id\": \"\",\n            \"company\": 339\n        },\n        ...\n    ]\n}",
        "customLabel": ""
      },
      {
        "id": "h_a1gYwdMjUXEoMNjFAvC",
        "language": "404",
        "code": "{\n  \"message\": \"Ain't no cake like that.\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "23j86a9viICroBOfXSY-U"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}

Pagination

Default pagination is 20 results per page.

• limit - Number of results to return per page.

  • Example: limit=20

• offset - The initial index from which to return the results.

  • Example: offset=21

Filtering

The results can be filtered by various attributes on customer account or related to the customer account.

Possible filters:

• code

• name

• description

• phone

• address

• email

• reference

• metadata