Skip to main content
GET
/
v2
/
budgets
cURL
curl --request GET \
  --url https://api.orq.ai/v2/budgets \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "type": "contact",
      "contact_id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "limit_amount": 1000,
      "period": "monthly",
      "is_active": true,
      "created": "2024-01-15T10:30:00Z",
      "updated": "2024-01-15T10:30:00Z"
    }
  ],
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

Required range: 1 <= x <= 50
​
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

​
ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

​
type
enum<string>

Filter by budget entity type (contact or workspace)

Available options:
contact,
workspace
Example:

"contact"

​
entity_id
string

Filter by specific entity ID

Example:

"contact_01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
is_active
boolean | null

Filter by active status

Example:

true

Response

200 - application/json

List of budget configurations

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
has_more
boolean
required