Agency Group Candidate Widgets

Retrieves a list of all candidate widgets for specific agency group

get/agency-group/{agency_group_id}/candidate-widgets

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency-group/{agency_group_id}/candidate-widgets
  • Auth
    HTTP basic

Query parameters

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

Response

All candidate widgets will be returned for specified Agency Group

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
type'welcome-widget' | 'legacy_dbs' required
contentstring required
candidate_typesstring[] required
candidate_statusesstring[] required
status'active' | 'inactive' required
agency_group_idstring required

Changes

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