Skip to main content
GET
/
v1
/
introductions
List introductions
curl --request GET \
  --url https://api.doozy.live/v1/introductions \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "introduction",
      "id": "intro_abc123",
      "status": "active",
      "frequency": "weekly",
      "intro_message": "**Welcome!** _Meet your new colleague!_",
      "destination": {
        "type": "slackChannel",
        "slackChannelId": "C1234567890"
      },
      "team_algorithm": "cross_team",
      "seniority_algorithm": "none",
      "location_algorithm": "none",
      "tenure_algorithm": "none",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-20T14:00:00.000Z",
      "type": "group",
      "group_size": 2
    }
  ],
  "has_more": true,
  "url": "/v1/introductions",
  "next_cursor": "intro_xyz789",
  "previous_cursor": "intro_abc123"
}

Authorizations

​
x-api-key
string
header
required

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

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:

"intro_abc123"

​
ending_before
string

Cursor for pagination (backward)

​
type
enum<string>

Filter by introduction type

Available options:
group,
individual
Example:

"group"

​
status
enum<string>

Filter by status

Available options:
active,
inactive
Example:

"active"

Response

List of introductions

​
object
enum<string>
required

String representing the object type

Available options:
list
Example:

"list"

​
data
object[]
required

Array of introduction 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"

​
next_cursor
string | null
required

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

Example:

"intro_xyz789"

​
previous_cursor
string | null
required

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

Example:

"intro_abc123"