Get application

GET /api/v3/applications/{id}

Request

Response

URL

GET https://example.aha.io/api/v3/applications/123

cURL command

curl --request GET 'https://example.aha.io/api/v3/applications/123' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

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

Account subdomain

The part before .aha.io. Leave blank to use the example domain.

ID of the application

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.

Search fields

Field	Type	Returned by default
Unique record ID.	integer	Yes
Include id in response
API URL for the record.	string	Yes
Include url in response
Reference prefix of the application.	string	Yes
Include reference_prefix in response
Name of the record.	string	Yes
Include name in response
Whether the record is an application or prototype.	string	No
Include type in response Allowed values: `applicationprototype`
Tags associated with the application. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource.	Collection	No
Collection envelope Records use the associated fields below. Type: `object` Required properties: records, has_more. url Type: `string` (uri) has_more Type: `boolean` next_url Type: `string` (uri) Include tags in response Expand this association to browse its response fields.
Date and time when the record was created.	date-time	No
Include created_at in response
Date and time when the record was last updated.	date-time	No
Include updated_at in response
User who created the application.	User	No
Include created_by_user in response Expand this association to browse its response fields.
Description of the application.	Note	No
Include description in response Expand this association to browse its response fields.
Production URL of the application.	string	No
Include production_url in response
Deployment status of the application.	string	No
Include deployment_status in response Allowed values: `enableddisablednot_deployed`
Lifecycle status of the application.	string	No
Include application_status in response Allowed values: `planningdevelopingdeployedarchived`
Whether the prototype is shared.	boolean	No
Include shared in response
Authentication methods enabled in production.	array	No
Include authentication_methods in response

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.

Download the complete OpenAPI specification