--- title: "Advanced search on Agency client" method: POST path: "/agency/{agency_id}/advanced-search/agency-client" tags: ["Agency Client Advanced Search"] --- # Advanced search on Agency client `POST /agency/{agency_id}/advanced-search/agency-client` ## Request - Base URL: `http://localhost:3010/v1` - URL: `http://localhost:3010/v1/agency/{agency_id}/advanced-search/agency-client` - Auth: HTTP basic ## Request body - AgencyClientAdvancedSearchQuery - `sort` string[] - `page` integer - `items_per_page` integer - `query` object - `and` AgencyClientAdvancedSearchQueryFields[] - `and` AgencyClientAdvancedSearchQueryFields[] - `or` AgencyClientAdvancedSearchQueryFields[] - `next_shift_at` 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[] - `previous_shift_at` 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[] - `first_shift_at` 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[] - `next_booking_at` 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[] - `previous_booking_at` 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[] - `first_booking_at` 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[] - `linked` AdvancedSearchOperationsBooleanField - `equal` boolean - `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 - `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 - `node_level` 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 - `client_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 - `site_type_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_type_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_type_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_type_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_address_line_1` 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_address_line_2` 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_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 - `site_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 - `site_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 - `site_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 - `site_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 - `ward_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 - `site_physical_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. - `compliance_contract_link_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 - `compliance_contract_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 - `compliance_contract_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 - `compliance_contract_description` 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 - `compliance_contract_status` 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 - `activities` object - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `contains` AdvancedSearchActivitiesQueryFields[] - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `contains_any` AdvancedSearchActivitiesQueryFields[] - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `client_tag_links` object - `tag_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` AdvancedSearchTagsLinksQueryFields[] - `tag_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` AdvancedSearchTagsLinksQueryFields[] - `tag_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 - `client_consultants` object - `consultant_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 - `consultant_role_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` AdvancedSearchClientConsultantsQueryFields[] - `consultant_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 - `consultant_role_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` AdvancedSearchClientConsultantsQueryFields[] - `consultant_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 - `consultant_role_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 - `client_consultant_role_details` object - `consultant_role_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 - `total_consultants` 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[] - `contains` AdvancedSearchClientConsultantRoleDetailsQueryFields[] - `consultant_role_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 - `total_consultants` 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[] - `contains_any` AdvancedSearchClientConsultantRoleDetailsQueryFields[] - `consultant_role_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 - `total_consultants` 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[] - `payroll_contract_links` object - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `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 - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinksQueryFields[] - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinksQueryFields[] - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `has_payroll_contract` AdvancedSearchOperationsBooleanField - `equal` boolean - `has_active_payroll_contract` AdvancedSearchOperationsBooleanField - `equal` boolean - `payment_term` 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 - `payment_term_inherited` AdvancedSearchOperationsBooleanField - `equal` boolean - `financial_hold` 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 - `financial_hold_inherited` AdvancedSearchOperationsBooleanField - `equal` boolean - `booking_preferences` object - `requires_po_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_unique_po_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_booking_password` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_shift_ref_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `client_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 - `allocated_agency_verified_documents` object - `document_type_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 - `issued_at` 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[] - `expire_at` 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[] - `verified_at` 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[] - `contains` AdvancedSearchAllocatedAgencyVerifiedDocumentsQueryFields[] - `document_type_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 - `issued_at` 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[] - `expire_at` 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[] - `verified_at` 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[] - `contains_any` AdvancedSearchAllocatedAgencyVerifiedDocumentsQueryFields[] - `document_type_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 - `issued_at` 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[] - `expire_at` 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[] - `verified_at` 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[] - `has_pending_agency_verification_documents` AdvancedSearchOperationsBooleanField - `equal` boolean - `package_of_care` 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` AgencyClientAdvancedSearchQueryFields[] - `and` AgencyClientAdvancedSearchQueryFields[] - `or` AgencyClientAdvancedSearchQueryFields[] - `next_shift_at` 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[] - `previous_shift_at` 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[] - `first_shift_at` 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[] - `next_booking_at` 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[] - `previous_booking_at` 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[] - `first_booking_at` 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[] - `linked` AdvancedSearchOperationsBooleanField - `equal` boolean - `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 - `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 - `node_level` 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 - `client_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 - `site_type_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_type_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_type_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_type_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_address_line_1` 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_address_line_2` 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_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 - `site_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 - `site_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 - `site_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 - `site_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 - `ward_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 - `site_physical_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. - `compliance_contract_link_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 - `compliance_contract_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 - `compliance_contract_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 - `compliance_contract_description` 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 - `compliance_contract_status` 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 - `activities` object - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `contains` AdvancedSearchActivitiesQueryFields[] - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `contains_any` AdvancedSearchActivitiesQueryFields[] - `activity_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 - `total` AdvancedSearchOperationsIntegerField - `equal` integer, nullable - `greater_than` integer, nullable - `less_than` integer, nullable - `greater_than_equal` integer, nullable - `less_than_equal` integer, nullable - `in` integer[] - `nin` integer[] - `last_activity_at` 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[] - `client_tag_links` object - `tag_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` AdvancedSearchTagsLinksQueryFields[] - `tag_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` AdvancedSearchTagsLinksQueryFields[] - `tag_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 - `client_consultants` object - `consultant_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 - `consultant_role_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` AdvancedSearchClientConsultantsQueryFields[] - `consultant_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 - `consultant_role_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` AdvancedSearchClientConsultantsQueryFields[] - `consultant_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 - `consultant_role_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 - `client_consultant_role_details` object - `consultant_role_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 - `total_consultants` 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[] - `contains` AdvancedSearchClientConsultantRoleDetailsQueryFields[] - `consultant_role_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 - `total_consultants` 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[] - `contains_any` AdvancedSearchClientConsultantRoleDetailsQueryFields[] - `consultant_role_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 - `total_consultants` 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[] - `payroll_contract_links` object - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `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 - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinksQueryFields[] - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinksQueryFields[] - `contract_link_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 - `contract_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 - `contract_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 - `contract_version` 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[] - `link_status` 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 - `flexible_rates_mode` 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 - `allow_rate_adjustment_rules` AdvancedSearchOperationsBooleanField - `equal` boolean - `initial_start_date_time` 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[] - `final_end_date_time` 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_titles` object - `job_title_id` AdvancedSearchOperationsStringField - … - `job_title_name` AdvancedSearchOperationsStringField - … - `contains` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `contains_any` AdvancedSearchPayrollContractLinkJobTitlesQueryFields[] - … - `has_payroll_contract` AdvancedSearchOperationsBooleanField - `equal` boolean - `has_active_payroll_contract` AdvancedSearchOperationsBooleanField - `equal` boolean - `payment_term` 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 - `payment_term_inherited` AdvancedSearchOperationsBooleanField - `equal` boolean - `financial_hold` 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 - `financial_hold_inherited` AdvancedSearchOperationsBooleanField - `equal` boolean - `booking_preferences` object - `requires_po_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_unique_po_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_booking_password` AdvancedSearchOperationsBooleanField - `equal` boolean - `requires_shift_ref_number` AdvancedSearchOperationsBooleanField - `equal` boolean - `client_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 - `allocated_agency_verified_documents` object - `document_type_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 - `issued_at` 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[] - `expire_at` 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[] - `verified_at` 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[] - `contains` AdvancedSearchAllocatedAgencyVerifiedDocumentsQueryFields[] - `document_type_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 - `issued_at` 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[] - `expire_at` 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[] - `verified_at` 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[] - `contains_any` AdvancedSearchAllocatedAgencyVerifiedDocumentsQueryFields[] - `document_type_id` AdvancedSearchOperationsStringField - `like` string, nullable - … truncated; see the full OpenAPI document linked below ## Response `200` list of agency client based on search criteria - AgencyClientAdvancedSearchResult[] - `_id` string - `linked` boolean - `agency_id` string - `organisation_id` string - `organisation_name` string - `site_id` string - `site_name` string - `ward_id` string - `ward_name` string - `node_level` string - `client_reference` string - `site_type_id` string - `site_type_name` string - `ward_type_id` string - `ward_type_name` string - `site_address_line_1` string - `site_address_line_2` string - `site_province` string - `site_post_code` string - `site_city` string - `site_country_code` string - `site_reference_number` string - `site_timezone` string - `ward_reference_number` string - `site_physical_geo_location` PhysicalAddressGeoLocationDef - `type` 'Point', required - `coordinates` number[], required - `compliance_contract_link_id` string - `compliance_contract_id` string - `compliance_contract_name` string - `compliance_contract_description` string - `compliance_contract_status` string - `updated_at` string, date-time - `created_at` string, date-time - `__v` integer - `activities` ActivityTypeDef[] - `activity_type` string, required - `total` integer, required - `last_activity_at` string, date-time, required - `client_tag_links` TagsLinksDef[] - `tag_id` string, required - `client_consultants` ClientConsultantsDef[] - `_id` string, required - `consultant_id` string, required - `consultant_name` string, required - `consultant_role_id` string, required - `consultant_role_name` string, required - `client_consultant_role_details` ClientConsultantRoleDetailsDef[] - `consultant_role_id` string, required - `total_consultants` number, required - `payroll_contract_links` PayrollContractLinkDef[] - `contract_link_id` string, required - `contract_id` string - `contract_name` string - `contract_version` number - `link_status` string - `flexible_rates_mode` string - `allow_rate_adjustment_rules` boolean - `initial_start_date_time` string, date-time - `final_end_date_time` string, date-time - `job_titles` PayrollContractLinkJobTitleDef[] - `job_title_id` string - `job_title_name` string - `vat_applicable` boolean - `initial_start_date` string - `last_end_date` string - `contracted_job_titles` string[] - `has_payroll_contract` boolean - `has_active_payroll_contract` boolean - `next_shift_at` string, date-time - `previous_shift_at` string, date-time - `first_shift_at` string, date-time - `next_booking_at` string, date-time - `previous_booking_at` string, date-time - `first_booking_at` string, date-time - `payment_term` 'credit' | 'pay_in_advance' - `payment_term_inherited` boolean, required - `financial_hold` 'applied' | 'cleared' - `financial_hold_inherited` boolean, required - `booking_preferences` object, required - `requires_po_number` boolean, required - `requires_unique_po_number` boolean, required - `requires_booking_password` boolean, required - `requires_shift_ref_number` boolean, required - `allocated_agency_verified_documents` object[] - `document_type_id` string, required - `document_id` string, required - `verified_at` string, date-time, required - `issued_at` string, date-time - `expire_at` string, date-time - `has_pending_agency_verified_documents` boolean - `package_of_care` 'initiated' ## 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. - `403`: Permission denied error - `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.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)