GET
/
coa
/
api
/
budgets
List Budgets
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/budgets \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 123,
      "entity_name": "<string>",
      "prior_start_date": "<string>",
      "prior_end_date": "<string>",
      "department_name": "<string>",
      "tags": [
        {
          "id": 123,
          "group_name": "<string>",
          "parent_name": "<string>",
          "parent": 123,
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "customer": 123,
          "group": 123
        }
      ],
      "name": "<string>",
      "description": "<string>",
      "cadence": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "periods": 16383,
      "breakdown_type": "standard",
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "entity": 123,
      "department": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
entity
integer

Filter by entity ID

​
entity_name
string

Filter by entity name (partial match)

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
q
string

Search query - searches by budget name

​
sort
string
default:name

Sort order. Use field name for ascending, -field for descending. Supports multiple fields separated by comma. Default: name

Response

200 - application/json

The response is of type object.