labels

Read Labels

Changed on

List labels with optional filters and sorting.

get/api/v1/labels

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/login/access-token)

Query parameters

review_status'not_started' | 'in_progress' | 'completed'

Filter by review status

unlinkedboolean nullable

Filter labels not linked to a product (product_id is null)

order_bystring

Field to sort by

orderstring

Sort direction (asc or desc)

limitinteger

Page size limit

offsetinteger

Page offset

product_typestring

Product type

Response

Successful Response

totalinteger required
limitinteger required
offsetinteger required

Changes

  • e485acf58427Revision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 8a9518a78df4Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter extraction_status

    • warning

      deleted the query request parameter verification_status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter review_status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status