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(organisation,xxx): Filter imports by the organisation whose locations they loaded. This is how an organisation's own import history is read.
  • eq(requested_by,xxx): Filter by who uploaded the file.
  • eq(status,xxx): Filter by where the import has got to: pending, processing, completed or failed.
  • eq(default_location_type,xxx): Filter by the type the import applied to untyped rows.
  • ge(requested_at,xxx): Filter by when the file was uploaded, e.g. ge(requested_at,2026-09-01T00:00:00Z).

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by.

Defaults to -requested_at: an import history is read to find out what happened recently.

Available options:
requested_at,
-requested_at,
status,
-status
include
enum<string>[]

A comma separated list of related resources to include.

requester names who uploaded the file, which an import history is mostly read for, and default_location_type names the type the import applied to untyped rows. Both save a caller resolving an id it would otherwise have to fetch separately.

Available options:
organisation,
requester,
default_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

List of location imports.

JSON API response object

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

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

An organisation