List a customer unit's aliases by customer external ID

GET

https://api.agentpaid.io/api/v2/customers/external/:externalId/customer-units/:externalCustomerUnitId/aliases

GET

/api/v2/customers/external/:externalId/customer-units/:externalCustomerUnitId/aliases

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.listCustomerUnitAliasesByExternalId({
        externalId: "customer_123",
        externalCustomerUnitId: "team-research",
    });
}
main();

{
  "data": [
    {
      "alias": "research-team-alias",
      "customerId": "cus_abc123",
      "customerUnitExternalId": "team-research",
      "name": "Research Team",
      "description": "Alias for the research team unit under customer_123",
      "createdAt": "2024-03-10T08:00:00Z",
      "updatedAt": "2024-06-01T14:22:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

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. Addresses the customer by your external customer id.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired>=1 character

Customer ID from your system, stored on Paid as the customer’s externalId.

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