List customers with pagination

ExpressListPageResponse Express.List(, )

GET/v1/express

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

ParametersExpand Collapse

ExpressListParams parameters

string cursor

Base64 encoded cursor from previous response

Double limit

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

class ExpressListPageResponse:

Paginated list of Express customers

required IReadOnlyList<ExpressListResponse> ExpressCustomers

required DateTimeOffset? CreatedAt

Timestamp when the Express customer was created

formatdate-time

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1

required Boolean IsActive

Whether the Express customer is currently active

required DateTimeOffset? UpdatedAt

Timestamp when the Express customer was last updated

formatdate-time

required Long UserCount

Number of users currently in this Express customer

minimum0

string CreatedByApiKeyID

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

formatuuid

string CreatedByUserID

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

IReadOnlyDictionary<string, string> Metadata

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

required Boolean HasMore

string Cursor

List customers with pagination

ExpressListParams parameters = new();

var page = await client.Express.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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