Get idea portal

GET /api/v3/idea_portals/{id}

Request

Response

URL

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

cURL command

curl --request GET 'https://example.aha.io/api/v3/idea_portals/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 idea portal

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
External URL for the idea portal.	string	No
Include external_url in response
Name of the record.	string	Yes
Include name in response
Subtitle of the idea portal.	string	No
Include subtitle in response
Access level of the idea portal.	string	No
Include access in response Allowed values: `submit_onlypublicprivate`
Whether the idea portal is enabled.	boolean	No
Include enabled in response
Custom domain of the idea portal.	string	No
Include custom_domain in response
Company name of the idea portal.	string	No
Include company_name in response
Reply-to email address for the idea portal.	string	No
Include reply_to_email 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
Projects associated with the idea portal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=projects[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 projects in response Expand this association to browse its response fields.
Whether spam check is enabled for the idea portal.	boolean	No
Include spam_check_enabled in response
Whether search engine crawlers can index the idea portal.	boolean	No
Include indexed_for_crawlers in response
Logo URL for the idea portal.	string	No
Include logo_url in response
Favicon URL for the idea portal.	string	No
Include favicon_url in response
Email logo URL for the idea portal.	string	No
Include email_logo_url in response
Display style of the idea portal.	string	No
Include display_style in response Allowed values: `legacy_allow_iframeno_iframeiframe`
Custom CSS for the idea portal.	string	No
Include custom_css in response
Custom JavaScript for the idea portal.	string	No
Include custom_js in response
Custom header of the idea portal.	string	No
Include custom_header in response
Custom footer of the idea portal.	string	No
Include custom_footer in response
Color branding for the idea portal.	PortalBranding	No
Include portal_branding in response Expand this association to browse its response fields.
Whether comment visibility is enabled for the idea portal.	boolean	No
Include comment_visibility_enabled in response
Whether comment mentions is enabled for the idea portal.	boolean	No
Include comment_mentions_enabled in response
Whether comment likes is enabled for the idea portal.	boolean	No
Include comment_likes_enabled in response
Whether organization feedback is enabled for the idea portal.	boolean	No
Include my_org_feedback_enabled in response
Whether records from any workspace can be promoted to the idea portal.	boolean	No
Include allow_promoted_records_from_any_project in response
Whether ideas are restricted in the idea portal.	boolean	No
Include idea_restricted in response
Whether AI category suggestions are enabled for the idea portal.	boolean	No
Include ai_category_suggestions_enabled in response
Default idea visibility for Aha! users in the idea portal.	string	No
Include aha_user_default_idea_visibility in response Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default idea visibility for employees in the idea portal.	string	No
Include employee_default_idea_visibility in response Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default idea visibility for portal users in the idea portal.	string	No
Include portal_user_default_idea_visibility in response Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default comment visibility for Aha! users in the idea portal.	string	No
Include aha_user_default_comment_visibility in response Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Default comment visibility for employees in the idea portal.	string	No
Include employee_default_comment_visibility in response Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Default comment visibility for portal users in the idea portal.	string	No
Include portal_user_default_comment_visibility in response Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Whether proxy voting is enabled for the idea portal.	boolean	No
Include proxy_voting_enabled in response
Whether all proxy votes are enabled for the idea portal.	boolean	No
Include all_proxy_votes_enabled in response
Whether proxy votes are enabled for organization feedback.	boolean	No
Include my_org_feedback_proxy_votes_enabled in response
Maximum endorsements a user can add across the idea portal.	integer	No
Include max_endorsements_per_portal in response
Maximum endorsements a user can add to one idea.	integer	No
Include max_endorsements_per_idea in response
Whether organization counts are shown in the idea portal.	boolean	No
Include org_count_enabled in response
Whether email is enabled for the idea portal.	boolean	No
Include email_enabled in response
Whether weekly email is enabled for the idea portal.	boolean	No
Include weekly_email_enabled in response
Whether idea portal users are unsubscribed by default.	boolean	No
Include unsubscribe_users_by_default in response
Summary email frequency of the idea portal.	string	No
Include summary_email_frequency in response Allowed values: `monthlyweeklydaily`
ID of the outbound email domain used by the idea portal.	string	No
Include outbound_email_domain_id in response
Branding for idea portal emails.	EmailBranding	No
Include email_branding in response Expand this association to browse its response fields.
Default locale of the idea portal.	string	No
Include default_locale in response Allowed values: `enesdefrnl`
Enabled locales of the idea portal.	array	No
Include enabled_locales in response
Employee email patterns of the idea portal.	string	No
Include employee_email_patterns in response
Self registration email patterns of the idea portal.	string	No
Include self_registration_email_patterns in response
Whether user names are hidden in the idea portal.	boolean	No
Include hide_user_names in response
Whether portal users can view all other portal user names.	boolean	No
Include view_all_portal_user_names_enabled in response
Whether consent is enabled for the idea portal.	boolean	No
Include consent_enabled in response
Consent label of the idea portal.	string	No
Include consent_label in response
Whether IP address restrictions are ignored for the idea portal.	boolean	No
Include skip_ip_address_restrictions in response
Whether Aha! users must sign in to access the idea portal.	boolean	No
Include require_aha_user_login_enabled in response
Whether simple authentication is enabled for the idea portal.	boolean	No
Include simple_authentication_enabled 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