offers

List

Returns a list of Offer objects.<Footer>{/* BEGIN_ATS_OFFER_FETCH_SUPPORTED_FIELDS /}<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WYb2/aOhTGv0rllwjIKONuRbq64l8pbQldSdtVUxUdnEMwOHGwnUCZ9t2vEuhKdnvRhlzWvbR9/Nj5+fGxna+EgkZfyEdSJ6AVKZJAeMhJnQzGY5SkSCBiNgS4bneTY1IkKo4iITV6pwy5p84kjkmdWAFKH0txyMYMPQu0slio0ZegmQiV9b1XaZx1I0XCWThDr0GpiEO9Q2cdV4J14A/FtFlpUiQRKKUnUsT+5BrnMapdkulsOAYYauAlDzRYW91Lct3/pbp03h5y1Oi1QUMbNdL0AzdDTbSOVN2yJsijcjZs2cPEwtACqRnlqKxa9eT4w0mttFHJRv/H9fnflcJ0PhKjDwXXp9yFuNB36NJ2egt76r+3W++X9uqmZq9mK3s6e1dwfSj0nX5t4NxXB+1GZfBCgDv86/PJbbPdPLcLdNWp2tP7he3QSt+hs9GqVz3v0sX52aelvbo/7rdvqrbTqZ13RWXQulb91rXoN8plUiTb60jqX75uV2zM0VCT0WM+tBeAj1tI1osAEStF8YgzWlbVMgSwEiEsVJmKwArQY2BlUu5wHoNE91L4wq3Gn+4gWZSj0H+iz0T4HT2pE7vh9G47eRM0EmAcRhxJXcsY/+NbUv9CIIo4o9l0SZFQLhR6LqRukhgIjS6VCPqHunTB8iU3Aj15rmJeuks0SJ224rqgY0Ue0pB5zCR6VyAhQI0yncfDt+LLUB+DETdFNdV6wpqMZt3xWO0g2rHPGnar0/51pibI7QGri4EZUlcc9FjIoIuBu0xu6UWl9iqcXtN7GOp1NwMu7ErEcCJihWb4Puttb/LyNPqTNrdJwKzV6w/NereXSroqw3sA85rluQfCczFKmDZk0I1Yzp0HY/j/vAw47RKT7FJnAFImlTulxb3/8bF5t2Mjv0auzDwn5Fsw4UAC5XjkAEdhBnIm9ZNZ8iBwd7jTZEYcNq6OhjGlqNQpUC2kMsMzr5lzb5N+Fv7pu98N+I0cScMApL5GKmOWBZqhnxfN4Z9+TC7Hnbs/4qzai6iDEGhgXBjKv896h84Pb9SyNxfdoyspjjYGY5mRDIC+uehuLlLucXPuLQfswK+B1wb+i5zvhJxl32KE7pNaLhkMEs5tfnIAM+9BdA9cHhj6NfJ0vd+I/p5n6U/eAXZv4Ydv/wJ9CIVzfBQAAA==" />{/ END_ATS_OFFER_FETCH_SUPPORTED_FIELDS */}</Footer>

get/ats/v1/offers

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/ats/v1/offers
  • Auth: HTTP bearer

Query parameters

application_idstring

If provided, will only return offers for this application.

created_afterstring date-time

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

created_beforestring date-time

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

creator_idstring

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

cursorstring

The pagination cursor value.

expandOffersGetParametersExpandSchemaItems[]

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

include_deleted_databoolean

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_databoolean

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

include_shell_databoolean

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

modified_afterstring date-time

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

modified_beforestring date-time

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

page_sizeinteger

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

remote_fields'status'

Deprecated. Use show_enum_origins.

remote_idstring

The API provider's ID for the given object.

show_enum_origins'status'

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

status'APPROVAL-SENT' | 'APPROVED' | 'DENIED' | 'DEPRECATED' | 'DRAFT' | 'OPENED' | 'SENT' | 'SENT-MANUALLY' | 'SIGNED'

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

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

nextstring nullable
previousstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.