Skip to main content
GET
/
v1
/
offers
List offers
curl --request GET \
  --url https://api.plane.com/v1/offers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "ofr_8kY3pQmNvT2sW9xF",
      "object": "offer",
      "status": "sent"
    }
  ],
  "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNi0xM1QxNjo0NTowMFoifQ"
}

​
Parameters

​
status
string
Filter offers by status. Supported values are draft, sent, accepted, declined, expired, and voided.
​
limit
integer
Number of offers to return.
​
cursor
string
Pagination cursor.

​
Returns

Returns a list envelope with Offer objects in data. 
{
  "object": "list",
  "data": [
    {
      "id": "ofr_8kY3pQmNvT2sW9xF",
      "object": "offer",
      "status": "sent"
    }
  ],
  "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNi0xM1QxNjo0NTowMFoifQ"
}