Qodex.ai

collections list

GET {{baseUrl}}/collections

Returns a list of Collection objects.

Request Params

KeyDatatypeRequiredDescription
collection_typestringIf provided, will only return collections of the given type.
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
expandstringWhich relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_datastringWhether to include data that was marked as deleted by third party webhooks.
include_remote_datastringWhether to include the original data Merge fetched from the third-party to produce these models.
modified_afterstringIf provided, only objects synced by Merge after this date time will be returned.
modified_beforestringIf provided, only objects synced by Merge before this date time will be returned.
page_sizestringNumber of results to return per page.
parent_collection_idstringIf provided, will only return collections whose parent collection matches the given id.
remote_fieldsstringDeprecated. Use show_enum_origins.
remote_idstringThe API provider's ID for the given object.
show_enum_originsstringA comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","results":[{"id":"\u003cuuid\u003e","remote_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","collection_type":"PROJECT","parent_collection":"\u003cuuid\u003e","remote_was_deleted":"\u003cboolean\u003e","access_level":"PRIVATE","field_mappings":{"anim__":{},"eiusmod_95b":{}},"remote_data":[{"path":"\u003cstring\u003e","data":{"readOnly":true}},{"path":"\u003cstring\u003e","data":{"readOnly":true}}]},{"id":"\u003cuuid\u003e","remote_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","collection_type":"PROJECT","parent_collection":"\u003cuuid\u003e","remote_was_deleted":"\u003cboolean\u003e","access_level":"PUBLIC","field_mappings":{"utcf7":{}},"remote_data":[{"path":"\u003cstring\u003e","data":{"readOnly":true}},{"path":"\u003cstring\u003e","data":{"readOnly":true}}]}]}