Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Source Tracking Links

sourceTrackingLink.list

List all source custom tracking links

Requires the hiringProcessMetadataRead permission.

post/sourceTrackingLink.list

Request body

includeDisabledboolean nullable

When true, includes disabled tracking links. Defaults to false.

sourceIdstring uuid nullable

Restrict the response to tracking links associated with this source id.

cursorstring nullable

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

limitinteger nullable

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

syncTokenstring nullable

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

Example request

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

Response

Responses from the sourceTrackingLink.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "code": "fx9iL4QtWr",
      "enabled": true,
      "sourceId": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
      "link": "https://jobs.ashbyhq.com/example?utm_source=fx9iL4QtWr"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}