GET
/
budgets
/
Get budgets
curl --request GET \
  --url https://api.standardmetrics.io/v1/budgets/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "#ffffff",
      "description": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "company": "<string>",
      "company_slug": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
company_slug
string

The slug of the company to fetch budgets for. You can find the slug for a company by going to that company's portfolio page, and then the last portion of the URL will be the unique slug for said company. For example: in the url: app.standardmetrics.io/venture/fund-slug/portfolio/example-slug/, "example-slug" would the the slug. This endpoint will return all budget data for your firm if a company slug isn't included. You can also make a request to the /companies endpoint to get a list of all your firm's companies and their slugs.

​
company_id
string

The id for the company to fetch budget data for. You can get a company's id by making a request to the /companies endpoint. This endpoint will return all budget data for your firm if a company id isn't included. You can get a company's id by making a request to the /companies endpoint.

​
sort_by
string

The field to sort your query by. Currently, created_at is the only supported field. To sort in descending order, prepend the field you're sorting by with a -. Ascending order is implied, but you can also prepend the field you're sorting by with + to sort in ascending order. E.g. to sort by created_at in ascending order use "sort_by=-created_at" and to sort by created_at in descending order use "sort_by=+created_at" or just "sort_by=created_at".

Response

200 - application/json

The response is of type object.