Skip to main content
GET
/
api
/
v1
/
offerings
List offerings
curl --request GET \
  --url https://app.vorel.ai/api/v1/offerings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "price": "<string>",
      "price_currency": "<string>",
      "photos": [
        "<string>"
      ],
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "reference_number": "<string>",
      "title_ar": "<string>",
      "description": "<string>",
      "description_ar": "<string>",
      "attributes": {},
      "address": "<string>",
      "available_from": "2023-12-25"
    }
  ],
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Query Parameters

​
limit
integer
default:25

Max rows per page. Server caps at 100.

Required range: 1 <= x <= 100
​
cursor
string<uuid>

Cursor from a prior page response. Omit for the first page.

Response

Page of offerings.

​
data
object[]
required
​
next_cursor
string<uuid> | null
required
​
has_more
boolean
required