Candidate Notification Settings

Retrieves list of all candidate notification settings

get/candidate/{candidate_id}/notification-settings

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/candidate/{candidate_id}/notification-settings
  • Auth
    HTTP basic and HTTP basic

Query parameters

pageinteger

The page number to be displayed

items_per_pageinteger

The items per page to be displayed

resource_typestring

The resource type of candidate notification setting to filter the results by

resource_idstring

The resource id of candidate notification setting to filter the results by

typestring

The type of candidate notification setting to filter the results by

sortBystring[]

The field to sort by together with sorting order example updated_at, -updated_at

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Response

List of all candidate notification settings will be returned

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
candidate_idstring required
resource_type'agency' | 'agency-group'
resource_idstring
valueboolean required
typestring required

Changes

No recorded changes to this operation across all 3 revisions of this API.