GET /api/locations
List all locations

Examples

GET /api/locations
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "data": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-19 07:30:49 UTC",
      "updated_at": "2021-05-19 07:30:49 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-19 07:30:49 UTC",
      "updated_at": "2021-05-19 07:30:49 UTC",
      "id": 373111740,
      "name": "Location 2",
      "title": "Location 2",
      "description": null
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return, ‘all’ to return all results Validations: Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name	Type	Possible values
description	text
id	integer
location_id	integer
name	string
title	string