List customers with pagination

GET/v1/express

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

Query ParametersExpand Collapse

cursor: optional string

Base64 encoded cursor from previous response

limit: optional number

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

expressCustomers: array of object { createdAt, expressCustomerId, expressCustomerName, 6 more }

createdAt: string

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

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId: optional string

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

formatuuid

createdByUserId: optional string

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

metadata: optional map[string]

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

hasMore: boolean

cursor: optional string

List customers with pagination

curl https://api.avarasoftware.com/v1/express \
    -H "Authorization: Bearer $AVARA_API_KEY"

{
  "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"
}