Retrieve list of location profile with filtering capabilities.

Supports searching by name, code, active status, parent location, and other fields using the filters parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filters
array of strings

Filter locations by field values. Format: filters[]={fieldName}:{value}
Multiple filters can be combined. Use the 'op' parameter to specify AND (default) or OR operation.

AND filter example (default):

GET /api/management/v2/locations?filters[]=isActive:1&filters[]=isWorkplace:1

Returns active workplace locations (both conditions must match)

OR filter example:

GET /api/management/v2/locations?filters[]=parentId:10&filters[]=parentId:20&op=OR

Returns locations with parent ID 10 OR 20 (either condition matches)

Available filterable fields:

  • id: Location ID
  • name: Location name
  • code: Location code
  • isActive: Active status (boolean: use 1 for true, 0 for false)
  • parentId: Parent location ID
  • isWorkplace: Is workplace (boolean: use 1 for true, 0 for false)
  • isPayCenter: Is pay center (boolean: use 1 for true, 0 for false)
filters
string

Controls how multiple filters are combined. Default is AND (all filters must match).
Valid values: "AND", "OR"

  • AND: All filter conditions must match (default behavior)
  • OR: Any filter condition can match. Example with AND (default):
GET /api/management/v2/locations?filters[]=isActive:1&filters[]=isWorkplace:1

Example with OR:

GET /api/management/v2/locations?filters[]=parentId:10&filters[]=parentId:20&op=OR
string

Pagination cursor from a previous response. Base64 encoded value that points to the position in the result set for the next page.
Use this value in subsequent requests to fetch the next page of results.

int32

Maximum number of location profiles to return in a single response. Used for pagination.

int32

Excludes soft deleted locations by default. Set to 0 to include soft deleted locations.

string

Field name to sort results by. The field name can be mapped through a column mapper if needed.

shiftIds
array of int32s

Optional shift IDs for permission bypass. When provided, checks if the requesting employee
has open shift invitations or cross-location shift assignments, and bypasses normal location
permission checks accordingly. Supports multiple shift IDs.

shiftIds
Response

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