---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Retrieve list of location profile with filtering capabilities.

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

# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "tenantlocationv2modelAddress": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "title": "Address Id"
          },
          "street": {
            "type": "string",
            "title": "Street address line"
          },
          "state": {
            "type": "string",
            "title": "State code, e.g: 'CA' for California or 'NSW' for New South Wales"
          },
          "postcode": {
            "type": "string",
            "title": "Postcode"
          },
          "country": {
            "type": "string",
            "title": "Country code, e.g: 'US' for the United States of America, 'AU' for Australia"
          },
          "verifiedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp of when the address was last verified"
          },
          "note": {
            "type": "string",
            "title": "Note"
          },
          "print": {
            "type": "string",
            "title": "[read-only] Print address in a single line string"
          }
        },
        "title": "Address data as response"
      },
      "LocationProfileListResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/v2modelLocationProfile"
            }
          },
          "nextCursor": {
            "type": "string",
            "description": "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."
          }
        },
        "title": "Get list of location profile response"
      },
      "modelLocationProfileLocationGeo": {
        "type": "object",
        "properties": {
          "latitude": {
            "type": "number",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "v2modelLocationProfile": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "title": "Location ID"
          },
          "code": {
            "type": "string",
            "title": "Location code"
          },
          "isActive": {
            "type": "boolean",
            "title": "If location is currently active"
          },
          "parentId": {
            "type": "integer",
            "format": "int32",
            "title": "Parent location ID"
          },
          "name": {
            "type": "string",
            "title": "Location name"
          },
          "isWorkplace": {
            "type": "boolean",
            "title": "If location is a workplace"
          },
          "isPayCenter": {
            "type": "boolean",
            "title": "If location is a pay center"
          },
          "payrollExportCode": {
            "type": "string",
            "title": "Location payroll export code"
          },
          "addressId": {
            "type": "integer",
            "format": "int32",
            "title": "Address ID connected to the location"
          },
          "contactId": {
            "type": "integer",
            "format": "int32",
            "title": "Contact ID connected to the location"
          },
          "createdById": {
            "type": "integer",
            "format": "int32",
            "title": "Employee ID who created the location"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp of when the location was created"
          },
          "modifiedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp of when the location was last modified"
          },
          "businessNumber": {
            "type": "string",
            "title": "Location business number"
          },
          "address": {
            "$ref": "#/components/schemas/tenantlocationv2modelAddress",
            "title": "Address object"
          },
          "geo": {
            "$ref": "#/components/schemas/modelLocationProfileLocationGeo"
          }
        },
        "title": "Location Profile"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/management/v2/locations": {
      "get": {
        "summary": "Retrieve list of location profile with filtering capabilities.",
        "description": "Supports searching by name, code, active status, parent location, and other fields using the filters parameter.",
        "operationId": "LocationProfileV2Controller_list",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationProfileListResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filters",
            "description": "Filter locations by field values. Format: filters[]={fieldName}:{value}\nMultiple filters can be combined. Use the 'op' parameter to specify AND (default) or OR operation.\n\nAND filter example (default): \n```\nGET /api/management/v2/locations?filters[]=isActive:1&filters[]=isWorkplace:1\n```\nReturns active workplace locations (both conditions must match)\n\nOR filter example: \n```\nGET /api/management/v2/locations?filters[]=parentId:10&filters[]=parentId:20&op=OR\n```\nReturns locations with parent ID 10 OR 20 (either condition matches)\n\nAvailable filterable fields:\n- id: Location ID\n- name: Location name\n- code: Location code\n- isActive: Active status (boolean: use 1 for true, 0 for false)\n- parentId: Parent location ID\n- isWorkplace: Is workplace (boolean: use 1 for true, 0 for false)\n- isPayCenter: Is pay center (boolean: use 1 for true, 0 for false)",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "op",
            "description": "Controls how multiple filters are combined. Default is AND (all filters must match).\nValid values: \"AND\", \"OR\"\n- AND: All filter conditions must match (default behavior)\n- OR: Any filter condition can match. Example with AND (default):\n\n```\nGET /api/management/v2/locations?filters[]=isActive:1&filters[]=isWorkplace:1\n```\n\nExample with OR: \n\n```\nGET /api/management/v2/locations?filters[]=parentId:10&filters[]=parentId:20&op=OR\n```",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "description": "Pagination cursor from a previous response. Base64 encoded value that points to the position in the result set for the next page.\nUse this value in subsequent requests to fetch the next page of results.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "description": "Maximum number of location profiles to return in a single response. Used for pagination.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "excludeSoft",
            "description": "Excludes soft deleted locations by default. Set to 0 to include soft deleted locations.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "orderBy",
            "description": "Field name to sort results by. The field name can be mapped through a column mapper if needed.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "shiftIds",
            "description": "Optional shift IDs for permission bypass. When provided, checks if the requesting employee\nhas open shift invitations or cross-location shift assignments, and bypasses normal location\npermission checks accordingly. Supports multiple shift IDs.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          }
        ],
        "tags": [
          "Location Profile"
        ]
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
````