Idea users API

List idea users for an account

GET /api/v1/idea_users

Parameters
NameDescription
page

Page number to return.

per_page

Number of records to return per page.

email

If provided, returns idea users with an email address matching the given value

idea_portal_id

If provided, returns idea users that are associated with the given idea portal

updated_since

UTC timestamp (in ISO8601 format). If provided, only idea_users updated after the timestamp will be returned

fields

Comma-separated list of fields to include for each idea user. Use * to include all default fields. When omitted, a default set of fields is returned. Supported fields: id, name, email, created_at, title, phone, discovery_interview_count, discovery_last_invite, discovery_last_interview, discovery_next_interview, idea_organizations, discovery_groups, portal_users, custom_fields, and integration_fields. Some fields (for example title, phone, and portal_users) are only returned when named explicitly and are not included by *. The discovery_* fields require a Discovery flavor.

Example request

GET /api/v1/idea_users?page=1&per_page=30

Example CURL command

curl -g "https://company.aha.io/api/v1/idea_users?page=1&per_page=30" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body