v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customer address types

Get all customer address types

Get a list of customer address types accepted in the CareCloud platform.

Address types categorise the additional addresses stored on a customer account - for example, delivery, billing, or work address. Use the returned IDs when creating or updating additional customer address records.

get/customer-address-types

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

Example response

{
  "data": {
    "customer_address_types": [
      {
        "address_type_id": "86e05affc7a7abefcd513ab400",
        "name": "Mailing address",
        "last_change": "2022-07-25 17:57:44.793447"
      }
    ],
    "total_items": 1
  }
}