List location types

GET

/location-types

const url = 'https://example.com/api/v1/location-types';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/location-types

Lists the location_type registry (the shape-definers a location is classified by), ordered alphabetically by label. Populates the type picker on the location form. Gated by location_type:read.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

location_types

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

allowed_parent_types

required

Array<string> | null

forked

required

True when this shipped row carries changes of yours overriding it. Restore discards them

boolean

icon

required

string

required

The location type’s uuid, the stable handle that survives a rename

string

label

required

string

label_rule

The label template locations of this type get; empty falls back to the global rule for locations

string

name

required

The name an operator reads and types; renameable

string

name_rule

How the platform NAMES locations of this type; absent means an operator names every one of them

object

bare_first

True when the first of this stem in a parent carries no ordinal

boolean

examples

required

The first two names this rule mints in one parent, produced by the same mint a create allocates from: the first shows whether the first of a stem carries a number, the second shows the shape every later one takes. Read these rather than rebuilding the shape, which is what keeps one definition of a generated name

Array<string> | null

stem

required

The generated name’s prefix; empty makes the type positional

string

official

required

True for a row this release ships. A shipped row is never written by an operator: an edit forks it

boolean

Example

{
  "$schema": "/api/v1/schemas/ListLocationTypesOutputBody.json",
  "location_types": [
    {
      "$schema": "/api/v1/schemas/LocationTypeBody.json"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}