Skip to content
Get started

Shared

ModelsExpand Collapse
APIKeyReference = object { apiKeyId, description, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid
description: string

Human-readable description of the API key

minLength1
isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

OrgReference = object { orgId, orgName }

A reference to an organization with basic identifying information

orgId: string

Unique organization identifier. Format: org_{32-hex-chars}

orgName: string

Name of the organization

minLength1
UserReference = object { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User's email address

userId: string

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

firstName: optional string

User's first name

lastName: optional string

User's last name

middleName: optional string

User's middle name

suffix1: optional string

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

suffix2: optional string

Additional name suffix