Skip to content
Get started

Shared

ModelsExpand Collapse
class ApiKeyReference:

A reference to an API key with basic identifying information

required string ApiKeyID

Unique API key identifier (UUIDv4 format)

formatuuid
required string Description

Human-readable description of the API key

minLength1
Boolean IsViewerEnabled

Whether this API key has access to the Viewer product

class ExpressCustomerReference:

A reference to an Express customer with basic identifying information

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1
class UserReference:

A reference to a user with basic identifying information

required string Email

User's email address

required string UserID

Unique user identifier. Format: usr_{32-hex-chars}

string FirstName

User's first name

string LastName

User's last name

string MiddleName

User's middle name

string Suffix1

Name suffix (e.g., 'MD', 'Jr.')

string Suffix2

Additional name suffix