Global Search

Get agency group global search suggestions

post/agency-group/{agency_group_id}/global-search-suggestions

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency-group/{agency_group_id}/global-search-suggestions
  • Auth
    HTTP basic and HTTP basic

Request body

index_typesstring[] required
search_termstring required
sizeinteger

Response

List of agency group global search results

Example response

{
  "results": [
    {
      "index_type": "candidate",
      "data": [
        {
          "_id": "5b16b824e8a73a752c42d848_5ff6dff8f36cb02cf3793c62",
          "candidate_id": "5ff6dff8f36cb02cf3793c62",
          "agency_group_id": "5b16b824e8a73a752c42d848",
          "full_name": "sample fullname",
          "contact_numbers": [
            "+1352519123456"
          ],
          "emails": [
            "sample_email@a24testmail.com"
          ],
          "employment_references": [
            "reference1",
            "reference2"
          ],
          "id_number": "123456666",
          "candidate_type_id": "gbr_care_course",
          "avatar_thumbnail_url": "someUrl",
          "current_status": "Archived"
        }
      ]
    }
  ]
}

Changes

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