API ReferenceCollections

List

List all collections that belong to your organization.

Headers

x-api-keystringRequired

Query parameters

skipintegerOptionalDefaults to 0
Number of collections to skip for pagination
limitintegerOptional>=1<=1000Defaults to 100

Maximum number of collections to return (1-1000)

Response

Successful Response
namestring

Human-readable display name for the collection.

readable_idstring

URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created.

idstringformat: "uuid"
Unique system identifier for the collection. This UUID is generated automatically and used for internal references.
created_atstringformat: "date-time"

Timestamp when the collection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the collection was last modified (ISO 8601 format).

organization_idstringformat: "uuid"
Identifier of the organization that owns this collection. Collections are isolated per organization.
created_by_emailstring or nullformat: "email"
Email address of the user who created this collection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this collection.
statusenum or null
Current operational status of the collection:<br/>• **NEEDS_SOURCE**: Collection exists but has no source connections configured yet<br/>• **ACTIVE**: All source connections are healthy and data is being synced successfully<br/>• **PARTIAL_ERROR**: Some source connections are failing but others are working<br/>• **ERROR**: All source connections are failing or in error state
Allowed values:

Errors