List business model components
GET /api/v3/business_model_components
Request conventions
API key or OAuth2 access token. See Authentication.
Use your account domain and token in copied requests. Request values and conditional fields must satisfy your account’s validation rules.
URL settings
The part before .aha.io. Leave blank to use the example domain.
Number of records per page (default 25, max 200)
Opaque cursor from a previous response to fetch the next page
Fields
Choose fields to return, filter, or sort. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.
Default response fields are returned until you select specific fields.
Add and edit filters and sorting in field details. Examples illustrate the response shape, not matching records.
| Field | Type | Returned by default | Sortable | Supported filters |
|---|---|---|---|---|
Unique record ID. | integer | Yes | Yes | eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty |
Name of the record. | string | Yes | No | None |
Position of the record relative to its siblings. | integer | No | Yes | eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty |
Color assigned to the record as a hex value. | string | No | No | None |
HTML description of the record. | Note | No | No | emptynot_empty |
Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. | ||||
Business model that contains the component. | BusinessModel | No | No | emptynot_empty |
Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. | ||||
Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.
Query syntax
Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.
Filter with filter.{operator}[{field}]=value. Multiple filters combine with AND. Use comma-separated values for in and not_in, two inclusive bounds for between, and true for empty and not_empty.
Sort with sort.asc={field} or sort.desc={field}. Explicit sorting limits results to 1,000 records. Omit sorting to retrieve all results in descending ID order.
Set the page size with per_page. Follow pagination.next_url while pagination.has_more is true.
Filter operators
eq equals; not_eq does not equal; contains contains text; starts_with starts with text (both case-insensitive).
gt greater than; gte greater than or equal; lt less than; lte less than or equal.
in matches any listed value; not_in excludes listed values; between matches an inclusive range; empty and not_empty check for an absent or present value.
See field selection, filtering, and pagination and sorting limits for details.
Response statuses
Error shape for 400, 401, 403
Type: object
error
Type: object
Required properties: status, code, message, request_id.
status
Type: integer
code
Type: string
message
Type: string
request_id
Type: string
Response envelope and pagination
records: array of records. Fields are documented above.
pagination
Type: object
Required properties: has_more.
has_more
Type: boolean
next_cursor
Type: string or null
next_url
Type: string or null (uri)
truncated
Type: boolean
truncated_message
Type: string