Skip to main content
GET
/
v1
/
introductions
/
{introductionId}
/
instances
List introduction instances
curl --request GET \
  --url https://api.doozy.live/v1/introductions/{introductionId}/instances \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "introduction_instance",
      "id": "inst_abc123",
      "introduction_id": "intro_abc123",
      "state": "complete",
      "match_at": "2024-02-01T09:00:00.000Z",
      "notify_at": "2024-01-31T09:00:00.000Z",
      "remind_at": "2024-02-03T09:00:00.000Z",
      "user_count": 20,
      "match_count": 10,
      "created_at": "2024-01-28T10:30:00.000Z",
      "updated_at": "2024-01-29T14:00:00.000Z"
    }
  ],
  "has_more": true,
  "url": "/v1/introductions/intro_abc123/instances",
  "next_cursor": "inst_xyz789",
  "previous_cursor": "inst_abc123"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Path Parameters

​
introductionId
string
required

Introduction ID

Example:

"intro_abc123"

Query Parameters

​
limit
integer
default:25

Maximum number of results to return (default: 25, max: 100)

Required range: 1 <= x <= 100
Example:

25

​
starting_after
string

Cursor for pagination

Example:

"inst_abc123"

Response

List of introduction instances

​
object
enum<string>
required

String representing the object type

Available options:
list
Example:

"list"

​
data
object[]
required

Array of instance objects

​
has_more
boolean
required

Whether there are more results available beyond this page

Example:

true

​
url
string
required

The URL for accessing this list endpoint

Example:

"/v1/introductions/intro_abc123/instances"

​
next_cursor
string | null
required

Cursor to fetch the next page of results. Pass as starting_after in subsequent requests.

Example:

"inst_xyz789"

​
previous_cursor
string | null
required

Cursor to fetch the previous page of results. Pass as ending_before in subsequent requests.

Example:

"inst_abc123"