All API categories

    Tags API

    9 endpoints

    Tag management for categorisation.

    GET
    Auth Required

    List all tags for a collection with optional filters and pagination.

    List all tags for a collection with optional filters and pagination.

    Endpoint

    /admin/collection/{collectionId}/tags

    Parameters

    collectionId
    path
    string
    Required

    Responses

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

    Create a single tag mapping.

    Create a single tag mapping.

    Endpoint

    /admin/collection/{collectionId}/tags

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CreateTagRequest
    Required

    See CreateTagRequest schema

    Responses

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

    tags.createBatch

    tags.createBatch

    Endpoint

    /admin/collection/{collectionId}/tags/batch

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CreateTagsBatchRequest
    Required

    See CreateTagsBatchRequest schema

    Responses

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

    Get a single tag mapping by tagId.

    Get a single tag mapping by tagId.

    Endpoint

    /admin/collection/{collectionId}/tags/{tagId}

    Parameters

    collectionId
    path
    string
    Required
    tagId
    path
    string
    Required

    Responses

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

    Update an existing tag mapping.

    Update an existing tag mapping.

    Endpoint

    /admin/collection/{collectionId}/tags/{tagId}

    Parameters

    collectionId
    path
    string
    Required
    tagId
    path
    string
    Required
    body
    body
    UpdateTagRequest
    Required

    See UpdateTagRequest schema

    Responses

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

    Delete a tag mapping.

    Delete a tag mapping.

    Endpoint

    /admin/collection/{collectionId}/tags/{tagId}

    Parameters

    collectionId
    path
    string
    Required
    tagId
    path
    string
    Required

    Responses

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

    Public batch lookup of multiple tags using query parameters (GET).

    Public batch lookup of multiple tags using query parameters (GET).

    Endpoint

    /public/tags/lookup

    Responses

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

    Public batch lookup of multiple tags in a single request (POST).

    Public batch lookup of multiple tags in a single request (POST).

    Endpoint

    /public/tags/lookup

    Parameters

    body
    body
    PublicBatchLookupRequest
    Required

    See PublicBatchLookupRequest schema

    Responses

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

    Public lookup of a single tag by tagId (global).

    Public lookup of a single tag by tagId (global).

    Endpoint

    /public/tags/{tagId}

    Parameters

    tagId
    path
    string
    Required

    Responses

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