/collections

Returns a list of Collection objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

collection_typeenumOptional

If provided, will only return collections of the given type.

Allowed values:

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

namestringOptional

If provided, will only return collections with this name.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

parent_collection_idstringOptional

If provided, will only return collections whose parent collection matches the given id.

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

remote_idstringOptional

The API provider's ID for the given object.

show_enum_originsenumOptional

A 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

A 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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

descriptionstring or nullOptional

The collection's description.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

parent_collectionstring or nullOptionalformat: "uuid"

The parent collection for this collection.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The collection's name.

access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

PRIVATE - PRIVATE
COMPANY - COMPANY
PUBLIC - PUBLIC
PARENT_COLLECTION - PARENT_COLLECTION

Allowed values:

collection_typeenum or nullOptional

The collection’s type.

LIST - LIST
PROJECT - PROJECT

Allowed values:

permissionslist of objectsOptionalRead-only

collection_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Collection.

remote_created_atdatetime or nullOptional

When the third party's collection was created.

remote_updated_atdatetime or nullOptional

When the third party's collection was updated.

remote_datalist of objects or nullOptionalRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	response = client.ticketing.collections.list(
8	cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9	)
10	for item in response:
11	yield item
12	# alternatively, you can paginate page-by-page
13	for page in response.iter_pages():
14	yield page

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
7	"remote_id": "19202938",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"name": "Q1 Platform",
11	"description": "For tracking all tasks related to Platform for Q1",
12	"access_level": "PUBLIC",
13	"collection_type": "LIST",
14	"parent_collection": "25782302-5be1-4d78-8f46-2a5db72204ef",
15	"permissions": [
16	{}
17	],
18	"collection_url": "https://example.com",
19	"remote_created_at": "2022-01-01T00:00:00Z",
20	"remote_updated_at": "2022-01-01T00:00:00Z",
21	"remote_was_deleted": true,
22	"field_mappings": {
23	"organization_defined_targets": {
24	"custom_key": "custom_value"
25	},
26	"linked_account_defined_targets": {
27	"custom_key": "custom_value"
28	}
29	},
30	"remote_data": [
31	{
32	"path": "/platform-endpoint"
33	}
34	]
35	}
36	]
37	}

/collections

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration