curator/curations.list

Retrieves a list of Curations in your Curator Media Unit

URL

GET /v1.0/curator/curations.list

Parameters

Argument Required Default Value Example Description
unit_id Required - 12345678912345 ID of your Curator Media Unit.
tag_id Optional Null 94029382930209 Filter Curations by tag(s).Specifies the ID of the tag associated with a Curation. If the argument’s value is Null, Curations will not be filtered for specific tags.
status Optional Null public Filter Curations by status.
When it is set to “temporary” the curation is private, when it is set to “public”, the curation is public
If the argument’s value is Null, Curations will not be filtered for a specific status.
published Optional Null True Filter Stories by published date. Set this to “true” to retrieve Stories after the published date.
When it is set to “False”, it will retrieve the Stories before the published date.
If the argument’s value is Null, Stories will not be filtered for published date.
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.

Responses

{
    "ok": true,
    "curations": [
        {
            "id": "0123456",
            "annotation": "Why not to go to see cherry blossoms?",
            "status": "public",
            "published_at": "2015-12-30T20:09:31+00:00",
            "created_at": "2015-11-10T20:09:31+00:00",
            "updated_at": "2015-12-25T18:58:10+00:00",
            "content":{
                "url": "https://this.kiji.is/0123456",
                "url_curation": "https://this.kiji.is/0123456?c=0123456",
                "title": "Counting down to sakura blooming",
                "site_name": "The Nordot Post",
                "description": "Norem ipsum dolor sit amet, consectetur adipisicing edit,
                sed do eiusmod tempor incididunt  ut labore rt dolore magna aliqua.
                Ut enima ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut...",
                "image_url": "https://nordot-res.cloudinary.com/t_size_l/ch/images/0123456/origin_1.jpg",
                "image_url_w": 342,
                "image_url_h": 480,
                "image_thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/images/0123456/origin_1.jpg",
                "image_caption": "Ueno Onshi oark",
                "published_at": "2018-02-05T02:48:09+00:00",
                "expired_at": "2018-03-07T02:48:09+00:00",
                "deleted": false,
                "unit":{
                    "id": "1234567",
                    "name": "Nordot WEB",
                    "status": "public",
                    "signature_color": "1B62AA",
                    "header_type": "border",
                    "header_position": "center",
                    "copyright_owner": "The Nordot Post",
                    "default_post_expire_days": 30,
                    "created_at": "2015-11-16T20:15:13+00:00",
                    "updated_at": "2018-02-04T08:48:34+00:00",
                    "header_image":{
                      "url": "https://nordot-res.cloudinary.com/ch/units/000111222/header_2.png",
                      "url_w": 300,
                    },
                    "profile_image":{
                      "url": "https://nordot-res.cloudinary.com/ch/units/000111222/profile_1.jpg",
                      "square_200": "https://nordot-res.cloudinary.com/t_square_200/ch/units/000111222/profile_1.jpg"
                    },
                    "publisher":{
                      "id": "111222333",
                      "name": "MANTAN",
                      "created_at": "2015-11-16T19:38:02+00:00",
                    },
                    "language": "",
                    "timezone": ""
                }
            },
            "tags":[
                {
                    "id": "0123456",
                    "name": "News",
                    "created_at": "2016-04-18T06:16:19+00:00",
                    "updated_at": "2016-04-18T06:16:19+00:00"
                }
            ],
            "unit":{
                "id": "000111222quot",
                "name": "NDT",
                "path": "ndt",
                "status": "public",
                "signature_color": "FFD900",
                "header_type": "border",
                "header_position": "left",
                "profile_name": "ndt!",
                "introduction": "My favorite only...",
                "created_at": "2015-11-17T11:13:45+00:00",
                "updated_at": "2018-02-28T14:42:24+00:00",
                "header_image": null,
                "profile_image":{
                  "url": "https://nordot-res.cloudinary.com/cu/units/222333444/profile_6.png",
                  "thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/cu/units/222333444/profile_6.png"
                },
                "follow":{
                  "twitter_url": "",
                  "facebook_page_url": ""
                },
                "connection":{
                  "facebook": false,
                  "twitter": false
                },
                "publisher":{
                  "id": "222333444",
                  "name": "Nordot Inc.",
                  "created_at": "2015-11-16T19:02:38+00:00",
                },
                "language": "en-US",
                "timezone": "America/Indiana/Indianapolis",
                "website_urls":["https://www.222333444.jp/"],
                "facebook_url": "https://www.facebook.com/222333444",
                "twitter_url": "https://twitter.com/222333444",
                "instagram_url": "https://instagram.com/222333444"
            },
        },
    ...
    ],
    "paging": {
      "count": 10,
      "offset": 0,
      "limit": 10,
      "has_next": true
    }
}

If successful, the method returns an array list of “curator curation” object that meets the specified criteria. For more details, please refer to the “paging” and “curator curation” 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_tag_id Value passed for “tag_id” is invalid.
tag_not_found The tag cannot be found.
invalid_status Value passed for “status" is invalid.
invalid_published_at Value passed for “published_at” is invalid.
invalid_offset Value passed for “offset" is invalid.
invalid_limit Value passed for “limit" is invalid.

For other error codes, please refer to the Common Errors section of this document.