Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

location_import_id
string<uuid>
required

The unique identifier for the location import.

Query Parameters

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

Response

An individual location import.

JSON API response object

data
object
required

One bulk load of locations from an uploaded CSV, and what became of every row.

The record is the import's audit trail, and that is by design rather than by accident: the bulk write path emits no per-row events, because a per-row event for a 30,000-row file would put 30,000 messages on the platform's bus for one upload. So this record answers "who loaded what, and what did it do" on its own.

jsonapi
object
required
included
object[]

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

An organisation