Skip to main content
GET
/
api
/
invites
List Invites
curl --request GET \
  --url https://api.userintuition.ai/api/invites \
  --header 'Authorization: Bearer <token>'
{
  "invites": [
    {
      "id": "<string>",
      "assistant_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "company_name": "<string>",
      "name": "<string>",
      "user_id": "<string>",
      "app_id": "<string>",
      "study_id": "<string>",
      "issilent": false,
      "istest": false,
      "isuniversal": false,
      "is_reward_sent": false,
      "reward_sent_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "assistant_name": "<string>",
      "vapi_assistant_id": "<string>",
      "call_status": "2023-11-07T05:31:56Z",
      "enable_video_recording": true,
      "enable_chat": true,
      "screener_questions": [
        {
          "id": "<string>",
          "text": "<string>",
          "order": 123,
          "options": [
            {
              "id": "<string>",
              "text": "<string>",
              "disqualify": true
            }
          ]
        }
      ],
      "concept_image": "<unknown>",
      "study_type": "<string>",
      "is_concept_test": true,
      "language": "<string>",
      "chat_welcome_message": "<string>"
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123
}

Authorizations

​
Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
page_size
integer
default:10

Items per page (default: 10, max: 100)

Required range: 1 <= x <= 100
​
email
string

Filter by email address

​
company_name
string

Filter by company name

​
sent
boolean

Filter by sent status

​
search
string

Search by email, company name, name, or assistant name

​
app_id
string

Filter by app ID - defaults to user-intuition if not provided

​
assistant_id
string

Filter by assistant ID

​
study_id
string

Filter by study ID

Response

Paginated list of invites

​
invites
object[]
required
​
total_count
integer
required

Total number of invites

​
page
integer | null

Current page number

​
page_size
integer | null

Number of items per page