Get business model component
GET /api/v3/business_model_components/{id}
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.
ID of the business model component
Response fields
Choose which fields to include in the response. 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.
| Field | Type | Returned by default |
|---|---|---|
Unique record ID. | integer | Yes |
Name of the record. | string | Yes |
Position of the record relative to its siblings. | integer | No |
Color assigned to the record as a hex value. | string | No |
HTML description of the record. | Note | No |
Expand this association to browse its response fields. | ||
Business model that contains the component. | BusinessModel | No |
Expand this association to browse its response fields. | ||
Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.
Response field selection
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.
See field selection for details.
Response statuses
Error shape for 401, 403, 404
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
record: a single record. Fields are documented above.