Budgets

List Budgets

Lists all budgets.

GET

/budgets

List Budgets

curl --request GET \
  --url 'https://api.operating.app/v1/budgets?after=%3Cstring%3E&limit=123&createdBefore=%3Cstring%3E&createdSince=%3Cstring%3E&updatedBefore=%3Cstring%3E&updatedSince=%3Cstring%3E&fromAfter=%3Cstring%3E&fromBefore=%3Cstring%3E&projectId=%3Cstring%3E&throughAfter=%3Cstring%3E&throughBefore=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "amount": {
        "amount": 123,
        "currency": "default"
      },
      "createdAt": "<string>",
      "description": "<string>",
      "externallyInvoiced": true,
      "from": "<string>",
      "id": "<string>",
      "name": "<string>",
      "projectId": "<string>",
      "through": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "nextCursor": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

afterstringquery

For pagination. Return results after this cursor.

limitnumberquery

For pagination. Return at most this number of results.

createdBeforestringquery

Filter records by whether they were created before a certain instant in ISO8601 format in UTC.

createdSincestringquery

Filter records by whether they were created after a certain instant in ISO8601 format in UTC.

updatedBeforestringquery

Filter records by whether they were updated before a certain instant in ISO8601 format in UTC.

updatedSincestringquery

Filter records by whether they were updated after a certain instant in ISO8601 format in UTC.

fromAfterstringquery

Only return budgets with a from date after the given date in YYYY-MM-DD.

fromBeforestringquery

Only return budgets with a from date before the given date in YYYY-MM-DD.

projectIdstringquery

Only return budgets for the given project.

throughAfterstringquery

Only return budgets with a through date after the given date in YYYY-MM-DD.

throughBeforestringquery

Only return budgets with a through date before the given date in YYYY-MM-DD.

Response

Successful response

dataobject[]required

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team