Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Etsy shop ID.

Pattern: ^[1-9][0-9]{0,18}$
Example:

"48911633"

Query Parameters

sort
enum<string>
default:sales

sales (default: most estimated sales first), price (lowest USD price first) or newest (most recently listed first). Products where that value is unknown are left out.

Available options:
sales,
price,
newest
Example:

"sales"

limit
integer

Page size: at most 25, the default.

Required range: 1 <= x <= 25
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