Sign in
Budget

List budget lines

Returns budget lines that match all filters. Use expand to include contacts, phase totals, or phase data. Use the budget endpoint to get the full budget in one response.

get/projects/{projectId}/budget/lines

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}/budget/lines
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID or slug.

Query parameters

accountIdstring

Only lines with this account number. An account number may match multiple lines.

pathstring

Only the line at this account path, such as 1100/1110. An ambiguous path returns 409 account_path_ambiguous.

tagsstring

Only lines with these comma-separated tag IDs.

tagMode'any' | 'all' | 'none'

How multiple tag filters are combined. any matches at least one tag, all matches every tag, and none excludes matching tags.

How multiple tags values are combined.

typestring

Only lines with these comma-separated types.

expandBudgetLineExpand[]

Comma list of related data to inline on budget lines (depth ≤ 2). Unknown or too-deep key returns 400 expand_invalid.

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

withCountboolean

Include the total number of matching items. Defaults to false.

Response

A page of budget lines.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching lines; present only when withCount=true.

truncatedboolean

Whether the page ended before limit because some results were unavailable.

Example response

{
  "data": [
    {
      "id": "lin_7c1a2f",
      "accountId": "1100",
      "path": "1100",
      "type": "account",
      "description": "Camera",
      "parentId": "lin_root",
      "depth": 0,
      "sort": 0,
      "contactId": null,
      "tagIds": [
        "tag_vfx"
      ],
      "sourceId": null
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.