Skip to navigation

List a customer unit's aliases

Lists the aliases that land signals on this unit. A customer-level alias (created on the customer routes) points at the customer’s root unit, so it is listed under the root. Use the value returned as customer.id, for example cus_abc123; if you have your own customer ID, use the /api/v2/customers/external/{externalId}/… twin.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

idstringRequiredformat: "^cus_.+"
Paid customer display id
externalCustomerUnitIdstringRequired>=1 character

Your own id for the unit (its externalId), unique within this customer.

Query parameters

limitintegerOptional1-100Defaults to 10
offsetintegerOptional

Response

200
datalist of objects
paginationobject

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error