Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Offer

offer.list

Get a list of all offers with their latest version.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the offersRead permission.

post/offer.list

Request body

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

syncTokenstring nullable

A sync token to retrieve only offers updated since the last sync. Obtained from a previous list response.

limitnumber nullable

The maximum number of items to return per page. Maximum is 100.

createdAfternumber nullable

The API will return data after this date, expressed as milliseconds since the Unix epoch.

offerStatusOfferProcessStatus[] nullable

When supplied, only offers with provided offer-status(es) will be returned. Array must contain at least one value.

acceptanceStatusOfferAcceptanceStatus[] nullable

When supplied, only offers with provided acceptance-status(es) will be returned. Array must contain at least one value.

applicationIdstring uuid nullable

If provided, only returns the offers for the application with the supplied id

approvalStatusOfferVersionApprovalStatus[] nullable

When supplied, only offers whose latest version has one of the provided approval status(es) will be returned. Array must contain at least one value.

Example request

{
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25,
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the offer.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88",
      "decidedAt": null,
      "applicationId": "3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd",
      "acceptanceStatus": "Pending",
      "offerStatus": "WaitingOnCandidateResponse",
      "latestVersion": {
        "id": "698a9280-0a1d-4e72-acd0-b45c771363e8",
        "startDate": "2026-05-01",
        "salary": {
          "value": 100000,
          "currencyCode": "USD"
        },
        "createdAt": "2026-04-25T02:07:01.594Z",
        "openingId": "1bdb1c73-6ed5-4fc2-8486-16ce03a57c67",
        "customFields": [],
        "fileHandles": [],
        "approvalStatus": null
      },
      "formDefinition": {
        "sections": [
          {
            "fields": [
              {
                "isRequired": true,
                "field": {
                  "id": "69c5aa80-34c1-4385-88ed-b2b2676e639d",
                  "type": "UUID",
                  "path": "opening.id",
                  "humanReadablePath": "Opening",
                  "title": "Opening",
                  "isNullable": false
                }
              }
            ]
          }
        ]
      },
      "versions": []
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}