Get offers

Search and list offers with optional filtering by status, search term, and pagination.

GET/

Authorization

AuthorizationBearer token · headerrequired

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Scopes:read:offers

Query parameters

statusstring

Filter offers by status

Allowed:draftpendingawaiting_customercanceledbuyout_acceptedorder_placedexpiredrejected

searchTermstring

Search term to filter offers by customer name, email, or address

pageinteger

Page number (1-based)

min 1 · default: 1

pageSizeinteger

Number of offers per page

min 1 · max 100 · default: 25

includeDraftsstring

Include draft offers in the results. Drafts are left out by default. Filtering by status=draft returns drafts whatever this is set to.

default: "false"

Allowed:truefalse

Responses

200

Offers retrieved successfully

offersobject[]required

Show properties

Array of object

idstringrequired

statusstringrequired

Current offer status

thirdPartyIdstring | nullrequired

totalCountnumberrequired

statusesobject[]required

Show properties

Array of object

statusstringrequired

Offer status

countnumberrequired

pageInfoobjectrequired

Show properties

hasNextPagebooleanrequired

hasPreviousPagebooleanrequired

401

Unauthorized - Missing or invalid authentication

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

403

Forbidden - The presented token does not carry the required scope

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

500

Internal server error

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

Request

curl -X GET 'https://api.sibipro.com/prod/offers/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.sibipro.com/prod/offers/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

Response

{
  "offers": [
    {
      "id": "string",
      "status": "pending",
      "thirdPartyId": "string"
    }
  ],
  "totalCount": 0,
  "statuses": [
    {
      "status": "pending",
      "count": 0
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing authentication token"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "The presented token is missing the `read:offers` scope, which this endpoint requires. Create a token with the scopes you need at https://developer.sibipro.com."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred"
}