v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Take Home Assignment

takeHomeAssignment.list

Beta

This endpoint is in beta and may not be available for all organizations.

Lists take-home assignments visible to the caller, including candidate submission metadata and reviewer feedback status, and links each assignment to its interview definition through interviewId. Pass expand: ["interview"] to include that definition.

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

Requires the interviewsRead permission.

post/takeHomeAssignment.list

Request body

applicationIdstring uuid nullable

Filter to take-home assignments for this application

candidateIdstring uuid nullable

Filter to take-home assignments for this candidate

expandstring[] nullable

Choose to expand results and include related interview definitions.

cursorstring nullable

Opaque cursor indicating which page of results to fetch

syncTokenstring nullable

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

limitinteger nullable

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

Example request

{
  "applicationId": "7211e226-7802-41fd-8d55-2720fe9d534f",
  "candidateId": "bf94fe6c-2571-4745-a59e-50921782705e",
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the takeHomeAssignment.list endpoint

OR