List customers with pagination

express.list() -> SyncCursorExpressCustomers[ExpressListResponse]

GET/v1/express

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

ParametersExpand Collapse

cursor: Optional[str]

Base64 encoded cursor from previous response

limit: Optional[float]

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

class ExpressListResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

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

formatuuid

created_by_user_id: Optional[str]

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

metadata: Optional[Dict[str, str]]

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 os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
page = client.express.list()
page = page.express_customers[0]
print(page.created_at)

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