Merge API Documentation

Returns a list of Tag objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

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.

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.

page_sizeintegerOptional

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

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects

1	curl -G https://api.merge.dev/api/ats/v1/tags \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>" \
4	-d cursor=cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"remote_id": "4567",
7	"created_at": "2021-09-15T00:00:00Z",
8	"modified_at": "2021-10-16T00:00:00Z",
9	"name": "High-Priority",
10	"remote_was_deleted": true,
11	"field_mappings": {
12	"organization_defined_targets": {
13	"custom_key": "custom_value"
14	},
15	"linked_account_defined_targets": {
16	"custom_key": "custom_value"
17	}
18	},
19	"remote_data": [
20	{
21	"path": "/tags"
22	}
23	]
24	}
25	]
26	}

/tags

Authentication

Headers

Query parameters

Response

Field support by integration