JAjarvi
Offers

Get Offers

Changed on

Get all offers with their custom fields, files, and more. Results are paginated: limit defaults to 100 and caps at 1000, so read total and walk offset until you have collected every record.

get/rest/v2/offers

Request

  • Base URL
    https://functions.prod.jarvi.tech/v1/public-api
  • URL
    https://functions.prod.jarvi.tech/v1/public-api/rest/v2/offers
  • Auth
    API key in header X-API-KEY

Query parameters

limitnumber

The number of offers to return. Default is 100. Maximum is 1000

offsetnumber

The number of offers to skip. Default is 0.

wherestring

A JSON object string filtering the underlying projects, in the same shape as the where of GET /rest/v2/projects.

Response

Responses for GET /api/rest/offers

totalinteger

The total number of offers matching the query

Changes

  • 873dd84c25ebRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id listOffers was added

    • info

      api tag Offers added

    • info

      for the query request parameter where, the type was generalized from object to string

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status