Name of staff

Search term to filter staffs by name or email.

Manager of staff

Speciality of staff

Job title of staff

External id of staff

Industry of staff

Gender of staff

Status of staff

Language of staff

Visit type name of staff

The id of the location. Accepts multiple ids as a comma-separated list, in which case staff
associated with any of the given ids are returned.

The name of the location which staff in

The type of the location which staff in

The zip-code of the location which staff in

The city of the location which staff in

The country name of location which staff in

The region name (country subdivision) of location which staff in

The id of the service. Accepts multiple ids as a comma-separated list, in which case staff
associated with any of the given ids are returned.

The name of the service provided by staff

The type of the service provided by staff

• The ISO 3166-1 alpha-2 country code (e.g. 'US') of the near_by.city or near_by.zip_code to resolve to a coordinate.
• Required when near_by.city or near_by.zip_code is provided; providing near_by.country on its own is not a valid filter.
• Cannot be combined with near_by.latitude/near_by.longitude, or with the legacy latitude/longitude/distance parameters.

• The city to resolve (via Google Maps), together with near_by.country, to a coordinate to retrieve a list of all staffs within a certain radius.
• Mutually exclusive with near_by.zip_code; provide exactly one of the two.
• Requires near_by.country to also be provided.

• The zip/postal code to resolve (via Google Maps), together with near_by.country, to a coordinate to retrieve a list of all staffs within a certain radius.
• Mutually exclusive with near_by.city; provide exactly one of the two.
• Requires near_by.country to also be provided.

Order by field, should be one of -> name, external_id, manager, speciality, job_title, date_of_hire, created_at, updated_at

Sort field, should be one of -> DESC, ASC

Filters staffs by the values of their custom fields, using a structured query expression
in the format custom_field=<field_name> eq '<value>', combined with and/or and parentheses.
Only the eq operator is currently supported.

• A single comparison.
  ?custom_field=visit_category eq 'wellness'
  returns the staffs whose visit_category is wellness.
• or matches any of the given comparisons.
  ?custom_field=visit_category eq 'wellness' or visit_category eq 'acute_sick'
  returns the staffs whose visit_category is either wellness or acute_sick.
• and requires all of the given comparisons to match.
  ?custom_field=visit_category eq 'wellness' and has_parking eq 'true'
  returns only the staffs that are in the wellness category and have parking.
• Parentheses group comparisons and override the default precedence (and binds tighter than or).
  ?custom_field=visit_category eq 'wellness' and (has_parking eq 'true' or has_parking eq 'false')
• The parameter can be repeated (up to 50 times); repeated occurrences are combined with and.
  ?custom_field=visit_category eq 'wellness'&custom_field=has_parking eq 'true'
  is equivalent to ?custom_field=visit_category eq 'wellness' and has_parking eq 'true'.

Field names are matched case-insensitively. String values must be enclosed in single quotes;
a literal single quote within a value is escaped by doubling it ('').
Value matching is case-insensitive for regular text custom fields, but case-sensitive for
single-select and multi-select custom fields (the value must match one of the field's
defined options exactly). Omitting the parameter leaves the results unfiltered.