All API categories

    Location API

    5 endpoints

    Geolocation and location-based services.

    POST
    Auth Required

    Platform: Create a global location (super admin; requires features.adminApps) POST /platform/location / export async fun

    Platform: Create a global location (super admin; requires features.adminApps) POST /platform/location / export async fun

    Endpoint

    /admin/collection/{collectionId}/location

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    LocationPayload
    Required

    See LocationPayload schema

    Responses

    200
    Success
    {
  "schema": "Location"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Platform: Create a global location (super admin; requires features.adminApps) POST /platform/location

    Platform: Create a global location (super admin; requires features.adminApps) POST /platform/location

    Endpoint

    /platform/location

    Parameters

    body
    body
    LocationPayload
    Required

    See LocationPayload schema

    Responses

    200
    Success
    {
  "schema": "Location"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Admin: Search locations to pick during setup (combines collection + global) GET /admin/collection/:collectionId/location

    Admin: Search locations to pick during setup (combines collection + global) GET /admin/collection/:collectionId/location

    Endpoint

    /public/collection/{collectionId}/location/{locationId}

    Parameters

    collectionId
    path
    string
    Required
    locationId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "Location"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Admin: Create a collection-scoped location POST /admin/collection/:collectionId/location / export async function create(

    Admin: Create a collection-scoped location POST /admin/collection/:collectionId/location / export async function create(

    Endpoint

    /public/location/{locationId}

    Parameters

    locationId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "Location"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found