Costs#

Read-only access to cost records across activities for reporting and analysis.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/costs#

List cost records across activities, including creator details.

bash

GET /v1/costs?page_index=0&page_size=25&organization_id=org_123
Authorization: Bearer {token}

Name	Type	Required	Description
pageIndex	`integer`	Required	Zero-based page index for pagination.
pageSize	`integer`	Required	Number of items per page (1-100).
organizationId	`string (UUID)`	Required	Organization identifier.
activityId	`string (UUID)`	—	Filter by activity identifier.
creatorId	`string (UUID)`	—	Filter by creator identifier.
campaignId	`string (UUID)`	—	Filter by campaign identifier.

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.costs.list(params)

Count cost records with optional activity and creator filters.

bash

GET /v1/costs/count?organization_id=org_123
Authorization: Bearer {token}

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
activityId	`string (UUID)`	—	Filter by activity identifier.
creatorId	`string (UUID)`	—	Filter by creator identifier.
campaignId	`string (UUID)`	—	Filter by campaign identifier.

Returns { count } with the total number of matching records.

Underlying SDK method: bw.costs.count(params)

Retrieve distinct cost type labels used across the organization.

bash

GET /v1/costs/types?page_index=0&page_size=25&organization_id=org_123
Authorization: Bearer {token}

Name	Type	Required	Description
pageIndex	`integer`	Required	Zero-based page index for pagination.
pageSize	`integer`	Required	Number of items per page (1-100).
organizationId	`string (UUID)`	Required	Organization identifier.

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.costs.types.list(params)

Autocomplete

Use this endpoint to populate autocomplete suggestions when creating or editing cost records.