Skip to main content
GET
/
v1
/
listings
Get listings
curl --request GET \
  --url https://api.treet-test.co/v1/listings \
  --header 'X-Treet-Authentication-Key: <api-key>' \
  --header 'X-Treet-Client-Id: <api-key>'
{
  "listings": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "state": "OPEN",
      "condition": "GOOD",
      "sku": "SKU325",
      "availableInventory": 1,
      "externalIdentifier": "SKU325-good"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAw"
  }
}

Authorizations

​
X-Treet-Client-Id
string
header
required
​
X-Treet-Authentication-Key
string
header
required

Query Parameters

​
state
enum<string>

Filter by listing state.

Available options:
OPEN,
CLOSED
​
limit
integer
default:50

Number of listings to return per page. Must be between 1 and 200. Defaults to 50.

Required range: 1 <= x <= 200
​
after
string

A cursor for use in pagination. after defines your place in the list. For example, if a previous response's pageInfo.endCursor was abc, set after=abc to fetch the next page.

Response

Paginated listings response

​
listings
object[]
required

Page of listings.

​
pageInfo
object
required

Pagination metadata. Shared by all paginated Treet API endpoints.