Get discovery study

GET /api/v3/discovery_studies/{id}

Request

Response

URL

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

cURL command

curl --request GET 'https://example.aha.io/api/v3/discovery_studies/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 or reference number of the discovery study

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
URL to view the record in Aha!	string	Yes
Include html_url in response
API URL for the record.	string	Yes
Include url in response
Name of the record.	string	Yes
Include name in response
Reference number of the record.	string	Yes
Include reference_num in response
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
Start date of the record.	date	No
Include start_date in response
End date of the record.	date	No
Include end_date in response
Status of the study.	string	No
Include status in response Allowed values: `plannedin_progresspostponedcompletedcanceled`
Researchers for the study. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=researchers[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 researchers in response Expand this association to browse its response fields.
Type associated with the study.	DiscoveryStudyType	No
Include study_type in response Expand this association to browse its response fields.
HTML description of the record.	Note	No
Include description in response Expand this association to browse its response fields.
Workspace that contains the record.	Project	No
Include project in response Expand this association to browse its response fields.
Records linked to the study.	LinkedRecord	No
Include linked_records in response Expand this association to browse its response fields.
Custom field values. Property names are custom field definition keys, and each value is one of the supported formats below, depending on the field type. Omitted unless requested with the fields parameter or submitted in the request. Fields with no stored value are omitted.	object	No
Include custom_fields in responseCustom field API key Custom field keys depend on your account. Request `fields=custom_fields` or `fields=custom_fields.your_key`.
Interviews in the study. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=interviews[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 interviews in response 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.

Download the complete OpenAPI specification