List customers with pagination

client.express.list(?, ?): CursorExpressCustomers<ExpressListResponse { createdAt, expressCustomerId, expressCustomerName, 6 more } >

GET/v1/express

Retrieves a paginated list of customers with optional filtering by name. Returns up to 100 customers per request.

ParametersExpand Collapse

query: ExpressListParams { cursor, limit }

cursor?: string

Base64 encoded cursor from previous response

limit?: number

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

ExpressListResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

createdByUserId?: string

User ID who created this Express customer via dashboard, null if created via API key

metadata?: Record<string, string>

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

List customers with pagination

import Avara from 'avara';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const expressListResponse of client.express.list()) {
  console.log(expressListResponse.createdAt);
}

{
  "expressCustomers": [
    {
      "createdAt": "2024-01-15T09:00:00Z",
      "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
      "expressCustomerName": "City Medical Center - Radiology Department",
      "isActive": true,
      "updatedAt": "2024-03-15T14:20:00Z",
      "userCount": 15,
      "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
      "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
      "metadata": {
        "department": "radiology",
        "region": "northeast"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}

Returns Examples

{
  "expressCustomers": [
    {
      "createdAt": "2024-01-15T09:00:00Z",
      "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
      "expressCustomerName": "City Medical Center - Radiology Department",
      "isActive": true,
      "updatedAt": "2024-03-15T14:20:00Z",
      "userCount": 15,
      "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
      "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
      "metadata": {
        "department": "radiology",
        "region": "northeast"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}