Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter locations by ID.
  • eq(organisation,xxx): Filter locations by organisation ID.
  • eq(name,xxx): Filter locations by name.
  • contains(name,xxx): Filter locations where name contains value.
  • eq(location_type,xxx): Filter locations by location type ID.
  • eq(reference,xxx): Filter locations by the organisation's own reference.
  • contains(reference,xxx): Filter locations where reference contains value.
  • contains(description,xxx): Filter locations where description contains value.
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
created_at,
-created_at,
name,
-name,
reference,
-reference
include
enum<string>[]

A comma separated list of related resources to include.

location_type sideloads the location's type, which saves a list page fetching the whole taxonomy separately just to render type names.

Available options:
organisation,
location_type
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of locations.

JSON API response object

data
A list of locations · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a location is returned.

An organisation