curator/tags.list
Retrieves a list of tags in your Curator Media Unit
URL
GET /v1.0/curator/tags.list
Parameters
Argument | Required | Default Value | Example | Description |
---|---|---|---|---|
unit_id | Required | - | 12345678912345 | ID of the Curator Media Unit. |
offset | Optional | 0 | 0 | Defines the start position for retrieving items. Use a number between 0 to 5000 for this argument. |
limit | Optional | 10 | 10 | The argument indicates the maximum number of items to retrieve. Use a number between 1 to 100 for this argument. |
Responses
{
"ok": true,
"tags": [
{
"id": "9012345",
"name": "Hanami",
"created_at": "2015-11-10T20:09:31+00:00",
"updated_at": "2015-12-25T18:58:10+00:00"
},
...
],
"paging": {
"count": 10,
"offset": 0,
"limit": 10,
"has_next": true
}
}
If successful, the method returns an array list of “curator tag” object that meets the specified criteria. For more details, please refer to the “paging” and “curator tag” object sections.
Errors
Error Code | Description |
---|---|
no_unit_id | Value for "unit_id" is not specified. |
invalid_unit_id | Value passed for “unit_id" is invalid. |
unit_not_found | The Media Unit cannot be found. |
invalid_offset | Value passed for “offset" is invalid. |
invalid_limit | Value passed for “limit" is invalid. |
For other error codes, refer to the Common Errors section of this document.