STstackone
Rejected Reasons

List Rejected Reasons

Changed on
get/unified/ats/rejected_reasons

Request

  • Base URL
    https://api.stackone.com
  • URL
    https://api.stackone.com/unified/ats/rejected_reasons
  • Auth
    HTTP basic

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable
Example:id,remote_id,label,type,rejected_reason_type,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

updated_afterstring date-time nullable

Use a string with a date to only select results updated after that given date

Filter parameters that allow greater customisation of the list response

{
  "updated_after": "2020-01-01T00:00:00.000Z"
}
pagestring nullable

The page number of the results to fetch

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

updated_afterstring date-time nullable
Example:2020-01-01T00:00:00.000Z

Use a string with a date to only select results updated after that given date

sync_tokenstring nullable

The sync token to select the only updated results

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The list of rejected reasons was retrieved.

next_pagestring nullable
nextstring nullable

Example response

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "label": "Failed Phone Screen",
      "type": "rejected_by_organization",
      "rejected_reason_type": {
        "value": "rejected_by_organization"
      }
    }
  ]
}

Changes

  • f05020bf8387Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • b58ba92c35b6Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status