Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Rejection Details

List rejection details

Rejection details are the per-application rejection records — one row per rejected application, capturing who rejected it, when, why (the rejection reason), the linked rejection note, and any answers to the organization's rejection question custom fields. A rejection detail exists only after an application has been rejected; non-rejected applications are not represented here. Filter with application_ids to pull rejection details for specific applications, or with rejection_reason_ids to slice by reason (useful for auto-rejection workflow reporting, e.g. spam or time-bound rejections). To patch a rejection's reason or custom field answers, fetch the rejection detail id from this endpoint and pass it to PATCH /v3/rejection_details/{id} — the path id is the rejection detail id, not the application id.

get/v3/rejection_details

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
application_idsinteger[]

Comma separated list

rejection_reason_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

custom_field_option_idinteger

Return only rejection details whose question_custom_fields include the given custom field option. Use with single-select or multi-select rejection question custom fields to find every rejection tagged with a particular option.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
application_idinteger

Id of the application this rejection record belongs to. Rejection details exist only for rejected applications; there is one record per rejected application.

rejected_by_idinteger nullable

Id of the user who rejected the application. null for system-initiated rejections such as auto-rejection workflows.

rejection_note_idinteger nullable

Id of the note created on the application capturing the free-text rejection message, or null when no note was entered. The note body itself is not returned here — fetch it through /v3/notes/{id}.

rejection_reason_idinteger nullable

Id of the rejection reason selected for the application. References a /v3/rejection_reasons row scoped to the organization. null when the application was rejected without a reason.

rejected_atstring date-time nullable

Timestamp the application was rejected, in ISO 8601. null only for legacy or partially backfilled rejection records.

question_custom_fieldsobject nullable