List idea portals

GET /api/v3/idea_portals

Request

Response

URL

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

cURL command

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

per_page

Number of records per page (default 25, max 200)

after

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.

Search fields

Field	Type	Returned by default	Sortable	Supported filters
Unique record ID.	integer	Yes	Yes	`eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty`
Include id in responseSort by id
URL to view the record in Aha!	string	Yes	No	None
Include html_url in response
API URL for the record.	string	Yes	No	None
Include url in response
External URL for the idea portal.	string	No	No	None
Include external_url in response
Name of the record.	string	Yes	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include name in responseSort by name
Subtitle of the idea portal.	string	No	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include subtitle in responseSort by subtitle
Access level of the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include access in responseSort by access Allowed values: `submit_onlypublicprivate`
Whether the idea portal is enabled.	boolean	No	Yes	`eq`
Include enabled in responseSort by enabled
Custom domain of the idea portal.	string	No	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include custom_domain in responseSort by custom_domain
Company name of the idea portal.	string	No	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include company_name in responseSort by company_name
Reply-to email address for the idea portal.	string	No	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include reply_to_email in responseSort by reply_to_email
Date and time when the record was created.	date-time	No	Yes	`eqgtgteltltebetweenemptynot_empty`
Include created_at in responseSort by created_at
Date and time when the record was last updated.	date-time	No	Yes	`eqgtgteltltebetweenemptynot_empty`
Include updated_at in responseSort by updated_at
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	No	`emptynot_empty`
Collection envelope Records use the associated fields below. Type: `object` Required properties: records, has_more. Include projects in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Whether spam check is enabled for the idea portal.	boolean	No	Yes	`eq`
Include spam_check_enabled in responseSort by spam_check_enabled
Whether search engine crawlers can index the idea portal.	boolean	No	Yes	`eq`
Include indexed_for_crawlers in responseSort by indexed_for_crawlers
Logo URL for the idea portal.	string	No	No	None
Include logo_url in response
Favicon URL for the idea portal.	string	No	No	None
Include favicon_url in response
Email logo URL for the idea portal.	string	No	No	None
Include email_logo_url in response
Display style of the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include display_style in responseSort by display_style Allowed values: `legacy_allow_iframeno_iframeiframe`
Custom CSS for the idea portal.	string	No	No	None
Include custom_css in response
Custom JavaScript for the idea portal.	string	No	No	None
Include custom_js in response
Custom header of the idea portal.	string	No	No	None
Include custom_header in response
Custom footer of the idea portal.	string	No	No	None
Include custom_footer in response
Color branding for the idea portal.	PortalBranding	No	No	None
Include portal_branding in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Whether comment visibility is enabled for the idea portal.	boolean	No	Yes	`eq`
Include comment_visibility_enabled in responseSort by comment_visibility_enabled
Whether comment mentions is enabled for the idea portal.	boolean	No	Yes	`eq`
Include comment_mentions_enabled in responseSort by comment_mentions_enabled
Whether comment likes is enabled for the idea portal.	boolean	No	Yes	`eq`
Include comment_likes_enabled in responseSort by comment_likes_enabled
Whether organization feedback is enabled for the idea portal.	boolean	No	Yes	`eq`
Include my_org_feedback_enabled in responseSort by my_org_feedback_enabled
Whether records from any workspace can be promoted to the idea portal.	boolean	No	Yes	`eq`
Include allow_promoted_records_from_any_project in responseSort by allow_promoted_records_from_any_project
Whether ideas are restricted in the idea portal.	boolean	No	Yes	`eq`
Include idea_restricted in responseSort by idea_restricted
Whether AI category suggestions are enabled for the idea portal.	boolean	No	No	None
Include ai_category_suggestions_enabled in response
Default idea visibility for Aha! users in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include aha_user_default_idea_visibility in responseSort by aha_user_default_idea_visibility Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default idea visibility for employees in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include employee_default_idea_visibility in responseSort by employee_default_idea_visibility Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default idea visibility for portal users in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include portal_user_default_idea_visibility in responseSort by portal_user_default_idea_visibility Allowed values: `creatoremployeeemployee_or_creatorcreator_organizationpublic`
Default comment visibility for Aha! users in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include aha_user_default_comment_visibility in responseSort by aha_user_default_comment_visibility Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Default comment visibility for employees in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include employee_default_comment_visibility in responseSort by employee_default_comment_visibility Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Default comment visibility for portal users in the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include portal_user_default_comment_visibility in responseSort by portal_user_default_comment_visibility Allowed values: `visible_to_allvisible_to_creator_and_internal_users`
Whether proxy voting is enabled for the idea portal.	boolean	No	Yes	`eq`
Include proxy_voting_enabled in responseSort by proxy_voting_enabled
Whether all proxy votes are enabled for the idea portal.	boolean	No	Yes	`eq`
Include all_proxy_votes_enabled in responseSort by all_proxy_votes_enabled
Whether proxy votes are enabled for organization feedback.	boolean	No	Yes	`eq`
Include my_org_feedback_proxy_votes_enabled in responseSort by my_org_feedback_proxy_votes_enabled
Maximum endorsements a user can add across the idea portal.	integer	No	Yes	`eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty`
Include max_endorsements_per_portal in responseSort by max_endorsements_per_portal
Maximum endorsements a user can add to one idea.	integer	No	Yes	`eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty`
Include max_endorsements_per_idea in responseSort by max_endorsements_per_idea
Whether organization counts are shown in the idea portal.	boolean	No	Yes	`eq`
Include org_count_enabled in responseSort by org_count_enabled
Whether email is enabled for the idea portal.	boolean	No	No	None
Include email_enabled in response
Whether weekly email is enabled for the idea portal.	boolean	No	Yes	`eq`
Include weekly_email_enabled in responseSort by weekly_email_enabled
Whether idea portal users are unsubscribed by default.	boolean	No	Yes	`eq`
Include unsubscribe_users_by_default in responseSort by unsubscribe_users_by_default
Summary email frequency of the idea portal.	string	No	No	None
Include summary_email_frequency in response Allowed values: `monthlyweeklydaily`
ID of the outbound email domain used by the idea portal.	string	No	No	None
Include outbound_email_domain_id in response
Branding for idea portal emails.	EmailBranding	No	No	None
Include email_branding in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Default locale of the idea portal.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include default_locale in responseSort by default_locale Allowed values: `enesdefrnl`
Enabled locales of the idea portal.	array	No	No	None
Include enabled_locales in response
Employee email patterns of the idea portal.	string	No	No	None
Include employee_email_patterns in response
Self registration email patterns of the idea portal.	string	No	No	None
Include self_registration_email_patterns in response
Whether user names are hidden in the idea portal.	boolean	No	Yes	`eq`
Include hide_user_names in responseSort by hide_user_names
Whether portal users can view all other portal user names.	boolean	No	Yes	`eq`
Include view_all_portal_user_names_enabled in responseSort by view_all_portal_user_names_enabled
Whether consent is enabled for the idea portal.	boolean	No	Yes	`eq`
Include consent_enabled in responseSort by consent_enabled
Consent label of the idea portal.	string	No	No	None
Include consent_label in response
Whether IP address restrictions are ignored for the idea portal.	boolean	No	Yes	`eq`
Include skip_ip_address_restrictions in responseSort by skip_ip_address_restrictions
Whether Aha! users must sign in to access the idea portal.	boolean	No	Yes	`eq`
Include require_aha_user_login_enabled in responseSort by require_aha_user_login_enabled
Whether simple authentication is enabled for the idea portal.	boolean	No	Yes	`eq`
Include simple_authentication_enabled in responseSort by simple_authentication_enabled

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

Download the complete OpenAPI specification