Skip to content
Avara
Get started
API Reference

Express

Create a new customer
POST/v1/express
List customers with pagination
GET/v1/express
Retrieve a customer by ID
GET/v1/express/{expressCustomerId}
Update a customer
PATCH/v1/express/{expressCustomerId}
Deactivate a customer
POST/v1/express/{expressCustomerId}/deactivate
Reactivate a customer
POST/v1/express/{expressCustomerId}/reactivate
ModelsExpand Collapse
ExpressCreateResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressListResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressRetrieveResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressUpdateResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressDeactivateResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressReactivateResponse object { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

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

ExpressUsers

Add a user to a customer
POST/v1/express/{expressCustomerId}/users
Remove a user from a customer
DELETE/v1/express/{expressCustomerId}/users
ModelsExpand Collapse
UserAddResponse object { success, message }

Standard success response with optional message

success: boolean
message: optional string
UserRemoveResponse object { success, message }

Standard success response with optional message

success: boolean
message: optional string