All API categories

    Collections API

    9 endpoints

    Collection creation and management.

    POST
    Auth Required

    Update a specific settings group for a collection (admin endpoint).

    Update a specific settings group for a collection (admin endpoint).

    Endpoint

    /admin/collection

    Parameters

    body
    body
    CollectionCreateRequest
    Required

    See CollectionCreateRequest schema

    Responses

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

    Create a new collection (admin only).

    Create a new collection (admin only).

    Endpoint

    /admin/collection/{collectionId}

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CollectionUpdateRequest
    Required

    See CollectionUpdateRequest schema

    Responses

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

    Update a collection (admin only).

    Update a collection (admin only).

    Endpoint

    /admin/collection/{collectionId}

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Look up a serial number by code for a collection (admin only).

    Look up a serial number by code for a collection (admin only).

    Endpoint

    /admin/collection/{collectionId}/assignSN/{codeId}

    Parameters

    collectionId
    path
    string
    Required
    codeId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Delete a collection (admin only).

    Delete a collection (admin only).

    Endpoint

    /admin/collection/{collectionId}/getSN

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Look up a serial number by code for a collection (admin only).

    Look up a serial number by code for a collection (admin only).

    Endpoint

    /admin/collection/{collectionId}/lookupSN/{codeId}

    Parameters

    collectionId
    path
    string
    Required
    codeId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Retrieve all configured app module definitions for a collection (public endpoint).

    Retrieve all configured app module definitions for a collection (public endpoint).

    Endpoint

    /admin/collection/{collectionId}/settings/{settingGroup}

    Parameters

    collectionId
    path
    string
    Required
    settingGroup
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Retrieves all Collections.

    Retrieves all Collections.

    Endpoint

    /public/collection/getShortId/{shortId}

    Parameters

    shortId
    path
    string
    Required

    Responses

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

    Retrieve a specific settings group for a collection (public endpoint).

    Retrieve a specific settings group for a collection (public endpoint).

    Endpoint

    /public/collection/{collectionId}/app/config

    Parameters

    collectionId
    path
    string
    Required

    Responses

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