--- title: "Advanced search on Candidate shift" method: POST path: "/candidate/{candidate_id}/advanced-search/agency-shift" tags: ["Candidate Shift Advanced Search"] --- # Advanced search on Candidate shift `POST /candidate/{candidate_id}/advanced-search/agency-shift` ## Request body - CandidateShiftSearchAdvancedSearchQuery - `sort` string[] - `page` integer - `items_per_page` integer - `query` object - `and` CandidateShiftSearchAdvancedSearchQueryFields[] - `and` CandidateShiftSearchAdvancedSearchQueryFields[] - `or` CandidateShiftSearchAdvancedSearchQueryFields[] - `shift_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_reference` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `organisation_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `organisation_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `job_title_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `status_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `county` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_full_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `payroll_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `shift_reference_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `po_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `date_created` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_pay` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_unit` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_initial_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_final_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_address_line1` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_address_line2` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `address_line1` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `address_line2` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `min_distance` integer — The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `site_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `min_distance` integer — The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `booked_assignment_created_user_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_username` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_firstname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_lastname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_fullname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_context_type` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_context_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `order_skills` object - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains` AdvancedSearchOrderSkillQueryFields[] - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains_any` AdvancedSearchOrderSkillQueryFields[] - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_qualifications` object - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains` AdvancedSearchOrderQualificationQueryFields[] - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains_any` AdvancedSearchOrderQualificationQueryFields[] - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `or` CandidateShiftSearchAdvancedSearchQueryFields[] - `and` CandidateShiftSearchAdvancedSearchQueryFields[] - `or` CandidateShiftSearchAdvancedSearchQueryFields[] - `shift_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_reference` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `organisation_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `organisation_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `job_title_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `status_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `county` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_full_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `payroll_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `shift_reference_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `po_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `date_created` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_pay` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_unit` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_initial_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_final_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `contract_currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_address_line1` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_address_line2` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `address_line1` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `address_line2` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `min_distance` integer — The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `site_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `min_distance` integer — The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required — Array containing geo location in this form: [ , ] - `max_distance` integer, required — The max distance a location can be away from the specified location. - `booked_assignment_created_user_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_username` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_firstname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_lastname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_fullname` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_context_type` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_user_context_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `booked_assignment_created_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `order_skills` object - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains` AdvancedSearchOrderSkillQueryFields[] - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains_any` AdvancedSearchOrderSkillQueryFields[] - `skill_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_qualifications` object - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains` AdvancedSearchOrderQualificationQueryFields[] - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contains_any` AdvancedSearchOrderQualificationQueryFields[] - `qualification_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `project` object - `shift_id` 1 - `position_description` 1 - `staffing_instructions` 1 - `organisation_name` 1 - `assignment_id` 1 - `candidate_city` 1 - `candidate_province` 1 - `candidate_post_code` 1 - `candidate_country_code` 1 - `candidate_address_line1` 1 - `candidate_address_line2` 1 - `country_code` 1 - `address_line1` 1 - `address_line2` 1 - `candidate_geo_location` 1 - `site_geo_location` 1 - `order_id` 1, required - `order_reference` 1 - `order_timezone` 1 - `start_date` 1, required - `end_date` 1, required - `organisation_id` 1 - `site_id` 1 - `site_name` 1 - `ward_id` 1 - `ward_name` 1 - `job_family_id` 1 - `job_family_name` 1 - `job_title_id` 1 - `job_title_name` 1 - `status_code` 1 - `county` 1 - `city` 1 - `post_code` 1 - `candidate_id` 1, required - `candidate_full_name` 1 - `date_created` 1 - `payroll_number` 1 - `shift_reference_number` 1 - `po_number` 1 - `agency_id` 1 - `agency_name` 1 - `contract_pay` 1 - `contract_unit` 1 - `contract_initial_start_date` 1 - `contract_final_end_date` 1 - `contract_currency` 1 - `contract_breakdown` 1 - `booked_assignment_created_user_id` 1 - `booked_assignment_created_user_username` 1 - `booked_assignment_created_user_firstname` 1 - `booked_assignment_created_user_lastname` 1 - `booked_assignment_created_user_fullname` 1 - `booked_assignment_created_user_context_type` 1 - `booked_assignment_created_user_context_id` 1 - `booked_assignment_created_date` 1 ## Response `200` list of agency shift search based on search criteria - CandidateShiftSearchAdvancedSearchResult[] - `_id` string - `agency_id` string - `agency_name` string - `shift_id` string - `order_id` string - `organisation_id` string - `organisation_name` string - `site_id` string - `site_name` string - `ward_id` string - `ward_name` string - `job_family_id` string - `job_family_name` string - `job_title_id` string - `job_title_name` string - `order_reference` string - `status_code` string - `county` string - `post_code` string - `city` string - `candidate_id` string - `candidate_full_name` string - `payroll_number` string - `shift_reference_number` string - `po_number` string - `start_date` string, date-time - `end_date` string, date-time - `date_created` string, date-time - `contract_pay` number - `contract_unit` string - `contract_initial_start_date` string, date-time - `contract_final_end_date` string, date-time - `contract_currency` string - `candidate_city` string - `candidate_province` string - `candidate_post_code` string - `candidate_country_code` string - `candidate_address_line1` string - `candidate_address_line2` string - `country_code` string - `address_line1` string - `address_line2` string - `candidate_geo_location` PhysicalAddressGeoLocationDef - `type` 'Point', required - `coordinates` number[], required - `site_geo_location` PhysicalAddressGeoLocationDef - `type` 'Point', required - `coordinates` number[], required - `contract_breakdown` CandidateContractBreakdown[] - `start_date` string, date-time - `end_date` string, date-time - `contract_job_code` string - `pay_rate` number - `total_line_pay` number - `booked_assignment_created_user_id` string - `booked_assignment_created_user_username` string - `booked_assignment_created_user_firstname` string - `booked_assignment_created_user_lastname` string - `booked_assignment_created_user_fullname` string - `booked_assignment_created_user_context_type` string - `booked_assignment_created_user_context_id` string - `booked_assignment_created_date` string, date-time - `order_skills` object[] - `skill_id` string - `order_qualifications` object[] - `qualification_id` string - `order_timezone` string ## Other responses - `204` — No content - `400` — Validation Error. Usually caused by a missing or invalid parameter. - `401` — Authorization Error. Thrown if the user does not have access to resource. - `default` — Server error occurred --- [API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) · [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/staffshift/staffshift-api-gateway/revisions/6e2cb83db3a9/schema)