Skip to main content
cURL
Cost: 1 API credit per item returned.
Lists come oldest first, as List saved lists orders them. Each list’s items come as List saved items orders them: products, then shops, then keywords. Needs the saved:read scope. Items carry the same summaries and status values as a list’s items, and are charged the same way. Reading never fetches anything from Etsy.

Get an overview with per_list

per_list=3 keeps the first 3 items of each list (1 to 25). Without it, every item comes back. type keeps one kind. total counts the items this read returns, with each list cut at per_list, not every saved item. For the real sizes, read summary.lists:
Items saved or removed while you page may move the window. Each page reserves a charge for every item it can return, then settles to the items with data. See Pagination and Credits and limits.

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

type
enum<string>

Only items of this type: product, shop or keyword.

Available options:
product,
shop,
keyword
per_list
string

At most this many items of each list, 1-25: its first ones (products, then shops, then keywords). Without it, every item.

Pattern: ^[1-9][0-9]?$
Example:

"3"

limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required
summary
object
required