Tags

Flexible tagging system for organizing products and other resources.

GET

https://api.idol.io/api/v2

/tags

Retrieve all tags

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

Successful response

TagListResponse

TagResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/tags

curl https://api.idol.io/api/v2/tags \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "tags",
      "id": "id",
      "attributes": {
        "name": "name",
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "products": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        }
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Get tag details

GET

https://api.idol.io/api/v2

/tags/{id}

Retrieve details for a specific tag by ID

Get tag details › path Parameters

id

string · required

Resource ID

Get tag details › Responses

Successful response

TagResponse

TagResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/tags/{id}

curl https://api.idol.io/api/v2/tags/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "tags",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Playlists Extracts

Labelcamp API v2

Tags

Flexible tagging system for organizing products and other resources.

GET

https://api.idol.io/api/v2

/tags

Retrieve all tags

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

Successful response

TagListResponse

TagResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/tags

curl https://api.idol.io/api/v2/tags \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "tags",
      "id": "id",
      "attributes": {
        "name": "name",
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "products": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        }
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Get tag details

GET

https://api.idol.io/api/v2

/tags/{id}

Retrieve details for a specific tag by ID

Get tag details › path Parameters

id

string · required

Resource ID

Get tag details › Responses

Successful response

TagResponse

TagResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/tags/{id}

curl https://api.idol.io/api/v2/tags/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "tags",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Playlists Extracts

Tags

List tags

List tags › query Parameters

List tags › Responses

Get tag details

Get tag details › path Parameters

Get tag details › Responses

Tags

List tags

List tags › query Parameters

List tags › Responses

Get tag details

Get tag details › path Parameters

Get tag details › Responses