Skip to content

    Pre-launch API. The concepts described here are settled, but the API shape is not: request and response fields, parameters and defaults can still change. Build against it, and talk to your Luigi's Box contact before you put an integration into production.

    List tags

    View source
    GET
    /platform/v1/tags
    curl --request GET \
    --url 'https://api.eu1.luigisbox.ai/platform/v1/tags?page=1&size=20' \
    --header 'Authorization: Bearer <token>'

    List tags, ordered by id. Listing without organization_id spans every organization, which requires a grant that wide; name your organization instead. GET /platform/v1/me/entitlements returns the organizations your credentials reach, with their ids.

    organization_id
    Any of:
    string

    Only tags of this organization.

    dimension
    Any of:
    TagDimension

    Which kind of entity a Tag groups: catalogs, channels, or surfaces. A tag’s members are all of one dimension.

    string
    Allowed values: catalog channel surface

    Only tags that group this kind of entity.

    page
    Page
    integer
    default: 1 >= 1
    size
    Size
    integer
    default: 20 >= 1 <= 100

    Successful Response

    Media type application/json
    Page[Tag]
    object
    items
    required
    Items
    Array<object>
    Tag

    Tag response: identity + the members for its dimension.

    object
    created_at
    required
    Created At
    string format: date-time
    created_by
    required
    Any of:
    string
    dimension
    required
    TagDimension

    Which kind of entity a Tag groups: catalogs, channels, or surfaces. A tag’s members are all of one dimension.

    string
    Allowed values: catalog channel surface
    id
    required
    Id
    string
    members
    required
    Any of:
    Array<object>
    SurfaceMemberRef

    A surface member of a surface-dimension tag: a surface id paired with its catalog.

    object
    catalog_id
    required
    Catalog Id
    string
    surface_id
    required
    Surface Id
    string
    name
    required
    Name
    string
    organization_id
    required
    Organization Id
    string
    updated_at
    required
    Updated At
    string format: date-time
    updated_by
    required
    Any of:
    string
    page
    required
    Page
    integer
    size
    required
    Size
    integer
    total
    required
    Total
    integer
    Example
    {
    "items": [
    {
    "dimension": "catalog"
    }
    ]
    }

    Missing or invalid credentials

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }

    Authenticated but not permitted

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }

    Request validation failed

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }