Area Profile

List all existing areas with filtering capabilities

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

get/management/v2/areas

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/management/v2/areas
  • Auth
    API key in header OAuth

Query parameters

filtersstring[]

Filter areas 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/areas?filters[]=isActive:1&filters[]=locationId:1

Returns active areas in location with ID 1 (both conditions must match)

OR filter example:

GET /api/management/v2/areas?filters[]=locationId:1&filters[]=locationId:2&op=OR

Returns areas in location 1 OR location 2 (either condition matches)

Available filterable fields:

  • id: Area ID
  • name: Area name
  • locationId: Location ID
  • isActive: Active status (boolean: use 1 for true, 0 for false)
  • parentId: Parent area ID
  • workType: Work type
  • isOnRoster: Appears on roster (boolean: use 1 for true, 0 for false)
opstring

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/areas?filters[]=isActive:1&filters[]=locationId:1

Example with OR:

GET /api/management/v2/areas?filters[]=locationId:1&filters[]=locationId:2&op=OR
cursorstring

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.

limitinteger

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

excludeSoftinteger

When set to 1, excludes soft-deleted areas (areas in the deputec_trash table where orm = "DeputecOperationalUnit"). When 0 or not set, includes all areas.

shiftIdsinteger[]

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 area permission checks accordingly. Supports multiple shift IDs.

Response

A successful response.

successboolean
nextCursorstring

Cursor to fetch the next page of results. Base64 encoded value. Present only if more results are available. Empty string if this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.