API ReferenceCollections

Create Collection

Create a new collection.



The newly created collection is initially empty and does not contain any data until you explicitly add source connections to it.

Headers

X-API-Keystring or nullOptional
X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
namestringRequired>=4 characters<=64 characters

Human-readable display name for the collection. This appears in the UI and should clearly describe the data contained within (e.g., ‘Finance Data’).

readable_idstring or nullOptionalformat: "^[a-z0-9]+(-[a-z0-9]+)*$"

URL-safe unique identifier used in API endpoints. Must contain only lowercase letters, numbers, and hyphens. If not provided, it will be automatically generated from the collection name with a random suffix for uniqueness (e.g., ‘finance-data-ab123’).

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:
• NEEDS_SOURCE: Collection exists but has no source connections configured yet
• ACTIVE: All source connections are healthy and data is being synced successfully
• PARTIAL_ERROR: Some source connections are failing but others are working
• ERROR: All source connections are failing or in error state

Allowed values:

Errors