Skip to main content
GET
/
v2
/
budgets
/
{id}
cURL
curl --request GET \
  --url https://api.orq.ai/v2/budgets/{id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "contact",
  "budget": {
    "period": "monthly",
    "amount": 250
  },
  "is_active": true,
  "api_key_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "contact_id": "user_123",
  "consumption": {
    "current_amount": 125.5,
    "remaining_amount": 124.5,
    "period_start": "2024-01-01T00:00:00Z",
    "period_end": "2024-01-31T23:59:59Z"
  },
  "created": "2025-12-08T10:34:25.425Z",
  "updated": "2025-12-08T10:34:25.425Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Budget ID

Example:

"01K1J1AX8PGR63QRP7423NY008"

Response

Budget configuration

Budget configuration details

​
_id
string<ulid>
required

Unique ULID for the budget configuration

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
workspace_id
string<uuid>
required

Workspace identifier that owns this budget configuration

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
type
enum<string>
required

Budget entity type

Available options:
api_key,
contact,
workspace
Example:

"contact"

​
budget
object
required

Budget configuration

​
is_active
boolean
required

Whether this budget configuration is currently active

Example:

true

​
api_key_id
string<ulid>

API Key identifier (present when type is "api_key")

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
contact_id
string

Contact external identifier (present when type is "contact")

Example:

"user_123"

​
consumption
object
​
created
default:2025-12-08T10:34:25.425Z

The date and time the resource was created

​
updated
default:2025-12-08T10:34:25.425Z

The date and time the resource was last updated