search/contentsholder/units.list
Retrieves a list of Content Owner Media Units
URL
GET /v1.0/search/contentsholder/units.list
Parameters
Argument | Required | Default Value | Example | Description |
---|---|---|---|---|
offset | Optional | 0 | 0 | Defines the start position for retrieving items. Use a number between 0 to 1000 for this argument. |
offset | 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,
"units": [
{
"id": "0123456",
"name": "The Nordot Post",
"created_at": "2015-11-10T20:09:31+00:00",
"updated_at": "2015-12-25T18:58:10+00:00",
"header_image": {
"url": "https://img.nordot.jp/ch/units/0123456/header_1.png",
"url_w": 0,
"url_h": 0,
"thumb_360": "https://img.nordot.jp/t_thumb_360/ch/units/0123456/header_1.png"
},
"profile_image":{
"url": "https://nordot-res.cloudinary.com/ch/units/0123456/profile_1.jpg",
"square_200": ""
},
"publisher":{
"id": "1234567",
"name": "Nordot Inc.",
"created_at": "2018-02-11T13:32:52+00:00",
"updated_at": "2018-02-13T04:41:19+00:00"
}
},
...
],
"paging": {
"count": 10,
"offset": 0,
"limit": 10,
"has_next": true,
"total": 300
}
}
If successful, the method returns an array list of “contentsholder unit” object that meets the specified criteria. For more details, please refer to the “paging” and “search contentsholder unit” objects.
The total is "10000" if there are more than 10000 records.
Errors
Error Code | Description |
---|---|
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.