API Reference

referral.list

post
https://api.ashbyhq.com/referral.list

Gets all referral submissions that are visible to the acting user.

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

Requires the candidatesRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the application you'd like to fetch referrals for

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

-9007199254740991 to 9007199254740991

The maximum number of items to return per page. The maximum and default value is 100.

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

Unix timestamp (milliseconds). When provided, only referrals created at or after this time are returned.

This feature is in beta and may not be available for all organizations. When true, each form field's visibilityCondition tree is included. Defaults to false on this endpoint to keep responses small.

Response

Updated 3 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago