List starred items | Sample

5 parameters

tokenstringoptional

Authentication token with the `stars:read` scope.

countstringoptional

Number of starred items to request for the page.

pagestringoptional

Page number for the collection.

cursorstringoptional

Pagination cursor; set it to the `next_cursor` value returned by the previous response.

limitintegeroptional

Maximum number of items to return; fewer items may be returned even when more remain.

2 status codes

200Returns an object containing the starred `items`, an `ok` value of true, and paging information including the current page and total count.

itemsarray<array>required

okbooleanrequired

Allowed:true

pagingobjectoptional

defaultReturns an error object with `ok` set to false and an `error` value describing why the starred items could not be listed.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

Provide token with the stars:read scope when authentication is required. Pagination is mandatory: use cursor from the previous response_metadata.next_cursor, and use limit to control the maximum number of items returned.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.starsList.list({
  token: "sk_live_4eC39Hq",
  count: 20,
  page: 1,
  cursor: "example",
  limit: 20,
});

{
  "ok": true
}

Request

Response

Errors