Skip to content

Collections

POST /v1/collections
FieldTypeRequiredDescription
namestringCollection name (max 255 chars)
descriptionstringOptional description
custom_fieldsarrayCustom field definitions
Terminal window
curl -X POST https://api.nouncify.com/v1/collections \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Engineering Team"}'

Response 201 Created

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Engineering Team",
"description": null,
"custom_fields": [],
"member_count": 0,
"recorded_count": 0,
"created_at": "2026-04-01T00:00:00Z",
"updated_at": "2026-04-01T00:00:00Z"
}
GET /v1/collections
ParameterTypeDefaultDescription
limitinteger50Max results (1-100)
cursorstringPagination cursor

Response 200 OK

{
"data": [{ "id": "...", "name": "...", ... }],
"has_more": false,
"next_cursor": null
}
GET /v1/collections/{collection_id}
PATCH /v1/collections/{collection_id}
FieldTypeDescription
namestringNew name
descriptionstring | nullNew description
DELETE /v1/collections/{collection_id}

Archiving is a soft delete. The collection and its data are preserved but no longer returned in list queries.

Response 200 OK

{
"deleted": true,
"id": "550e8400-e29b-41d4-a716-446655440000"
}