Ashby API Integration Profile

Retrieve information about the API key being used to make the request.

Requires the apiKeysRead permission.

Change the source of an application.

Requires the candidatesWrite permission.

Change the stage of an application

Requires the candidatesWrite permission.

Consider a candidate for a job

Requires the candidatesWrite permission.

Fetch application details by application id or by submitted form instance id (which is return by the applicationForm.submit endpoint). If both applicationId and submittedFormInstanceId are provided, we will lookup by applicationId.

Requires the candidatesRead permission.

Gets all applications schedules in the organization.

Requires the candidatesRead permission.

List all feedback associated with an application.

Requires the candidatesRead permission.

The submittedValues field in the response contains the submitted feedback in an object where the key is the path of the field and the value is the value submitted for that field.

Application feedback forms support a variety of field types.

Requires the candidatesWrite permission.

The values accepted for each field depend on the type of field that's being filled out: |

• Boolean - A boolean value
• Date - A date string in the format YYYY-MM-DD
• Email - A valid email address
• Number - An integer
• RichText - We do not support submitting rich text documents via the API but we do support submitting plain text values for these fields. Plain text values must be submitted in the format { type: "PlainText", value: "A plain text string" }
• Score - An integer between 1 and 4 submitted in the format { score: 4 }
• Phone, String A string
• ValueSelect - A string that matches the value of one of the ValueSelect field's selectable options
• MultiValueSelect - An array of strings that exist in the MultiValueSelect field's selectable options

The submittedValues field in the response contains the submitted feedback in an object where the key is the path of the field and the value is the value submitted for that field.

Submit an application for a job posting.

Requires the candidatesWrite permission.

The Content-Type of this request must be multipart/form-data.

Note: The requests generated from this documentation will not work for this endpoint.