Search work locations

Search and page through a specific employer's work locations.

Searches the work locations of a single employer, identified by the path
parameter {employerId}. Returns a page of work locations matching the
supplied filters. Use the work-location metadata endpoint
(/v1/employers/work-locations/metadata/search) to discover
available field IDs and supported filter operators. There is no
single-work-location endpoint — read one by filtering on /workLocation/id.
(Work-location metadata is not employer-scoped; its endpoint is
/v1/employers/work-locations/metadata/search.)

Before using this endpoint

  • Discover readable field IDs (including custom fields) via the
    work-location metadata search endpoint.
    Out-of-the-box field IDs are also listed as keys on the WorkLocation
    response schema for this search endpoint.
  • Provide a numeric employerId in the path — use the employer search
    endpoint to look up employer IDs.
  • There is no single-work-location endpoint — filter on /workLocation/id
    with operator equals to read one work location.
  • Filterable field IDs: /workLocation/id, /workLocation/name,
    /workLocation/type, /workLocation/status, /workLocation/country. Any
    other fieldId in filters returns 400 Bad Request.

Pagination — cursor-based. next_cursor is null on the last page.
Search does not support sorting — order results client-side.

Testing notes

  • Use the testing widget's Try It! option to test this endpoint.
  • Open Examples and select Request Example to populate the request
    body. Replace the path employerId with a real employer ID from your
    company.
  • IDs must be sent as JSON strings even when they look numeric.

OAuth scope (app-user): employers:read.
IAM permission: Settings / Employers / View (company-scoped).

Path Params
string
required

Identifier of the parent employer whose work locations to search.

Body Params

Request body for work-location search. filters is required — send an empty
array ([]) to return every work location of the employer. fields is
optional; omit it to return all available fields. limit defaults to 50.

Request body for work-location search. filters is required — send an empty
array ([]) to return every work location of the employer. fields is
optional; omit it to return all available fields. limit defaults to 50.

fields
array of strings | null
Defaults to /workLocation/id,/workLocation/name,/workLocation/type,/workLocation/status

Field IDs to include in each result item. When omitted, all available
fields are returned. Discover the authoritative field catalog (including
custom fields) via the work-location metadata search endpoint;
out-of-the-box field IDs are also listed as keys on the WorkLocation
response schema.

fields
filters
array of objects
required
Defaults to []

Filters to apply within the employer's work locations. An empty list
returns every work location of the employer the caller has permission to
view.

filters*
integer | null
1 to 200
Defaults to 50

Maximum number of items per page (allowed range 1–200). Defaults to 50.

string | null

Opaque cursor from a previous response's response_metadata.next_cursor.
Omit on the first request.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json