Merge API Documentation

Returns a list of Offer objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

application_idstringOptional

If provided, will only return offers for this application.

created_afterdatetimeOptional

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

created_beforedatetimeOptional

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

creator_idstringOptional

If provided, will only return offers created by this user.

cursorstringOptional

The pagination cursor value.

expandlist of enumsOptional

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.

page_sizeintegerOptional

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

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:

statusenumOptional

If provided, will only return offers with this status. Options: (‘DRAFT’, ‘APPROVAL-SENT’, ‘APPROVED’, ‘SENT’, ‘SENT-MANUALLY’, ‘OPENED’, ‘DENIED’, ‘SIGNED’, ‘DEPRECATED’)

Response

nextstring or null

previousstring or null

resultslist of objects

1	curl -G https://api.merge.dev/api/ats/v1/offers \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>" \
4	-d application_id=application_id \
5	-d creator_id=creator_id \
6	-d cursor=cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw \
7	-d expand=application \
8	-d remote_fields=status \
9	-d show_enum_origins=status

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "dd85625c-6a59-446f-a317-6de64d83bae7",
7	"remote_id": "9876",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"application": "2872ba14-4084-492b-be96-e5eee6fc33ef",
11	"creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
12	"remote_created_at": "2021-10-15T00:00:00Z",
13	"closed_at": "2021-10-16T00:00:00Z",
14	"sent_at": "2021-10-15T00:00:00Z",
15	"start_date": "2021-11-15T00:00:00Z",
16	"status": "SENT",
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": "/offers",
29	"data": null
30	}
31	]
32	}
33	]
34	}

/offers

Authentication

Headers

Query parameters

Response

Field support by integration