/collections/{id}

GET

/ticketing/v1/collections/:id

GET

/api/ticketing/v1/collections/:id

$ curl -G https://api.merge.dev/api/ticketing/v1/collections/id \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d expand=parent_collection \
>      -d remote_fields=collection_type \
>      -d show_enum_origins=collection_type

200Retrieved

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

Returns a Collection object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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

Allowed values:

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).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

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

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

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.

collection_typeenum or nullOptional

The collection's type.

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_was_deletedbooleanOptional

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.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

/collections/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration