Skip to main content
GET
/
v1
/
introductions
/
{introductionId}
Get introduction details
curl --request GET \
  --url https://api.doozy.live/v1/introductions/{introductionId} \
  --header 'x-api-key: <api-key>'
{
  "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,
  "next_instance_id": "inst_def456",
  "remind_matches_to_meet": true,
  "max_matches_per_user": 1,
  "rounds_per_instance": 1,
  "default_meeting_duration": 30,
  "started_at": "2024-01-15T10:30:00.000Z",
  "end_at": null,
  "instance_count": 5,
  "total_match_count": 25,
  "opted_out_users": [
    {
      "user_id": "user_abc123",
      "slack_user_id": "U1234567890",
      "display_name": "John Doe",
      "email": "john@example.com"
    }
  ]
}

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"

Response

Introduction details

​
object
enum<string>
required

Object type identifier

Available options:
introduction
Example:

"introduction"

​
id
string
required

Unique introduction identifier

Example:

"intro_abc123"

​
status
enum<string>
required

Current status

Available options:
active,
inactive
Example:

"active"

​
frequency
enum<string>
required

How often introductions occur

Available options:
once,
weekly,
biweekly,
triweekly,
monthly,
daily,
quarterly,
semiannually,
annually
Example:

"weekly"

​
intro_message
string | null
required

Custom introduction message (Markdown)

Example:

"**Welcome!** _Meet your new colleague!_"

​
destination
object
required

Where introductions are delivered

​
team_algorithm
enum<string>
required

Team matching algorithm

Available options:
cross_team,
same_team,
random,
slack_connect
Example:

"cross_team"

​
seniority_algorithm
enum<string>
required

Seniority matching algorithm

Available options:
similar_seniority,
different_seniority,
none
Example:

"none"

​
location_algorithm
enum<string>
required

Location matching algorithm

Available options:
similar_location,
different_location,
none
Example:

"none"

​
tenure_algorithm
enum<string>
required

Tenure matching algorithm

Available options:
similar_tenure,
different_tenure,
none
Example:

"none"

​
created_at
string
required

ISO 8601 creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

​
updated_at
string | null
required

ISO 8601 last updated timestamp

Example:

"2024-01-20T14:00:00.000Z"

​
type
enum<string>
required

Type of introduction - group matches multiple people together

Available options:
group
Example:

"group"

​
group_size
integer
required

Number of people per group

Required range: 2 <= x <= 4
Example:

2

​
next_instance_id
string | null
required

ID of the next scheduled instance

Example:

"inst_def456"

​
remind_matches_to_meet
boolean | null
required

Whether to send meeting reminders

Example:

true

​
max_matches_per_user
integer | null
required

Maximum number of matches per user

Example:

1

​
rounds_per_instance
integer | null
required

Number of introduction rounds per instance

Example:

1

​
default_meeting_duration
integer | null
required

Default meeting duration in minutes

Example:

30

​
started_at
string | null
required

ISO 8601 timestamp when this was first activated

Example:

"2024-01-15T10:30:00.000Z"

​
end_at
string | null
required

ISO 8601 timestamp when this will end

Example:

null

​
instance_count
integer
required

Total number of instances

Example:

5

​
total_match_count
integer
required

Total number of matches across all instances

Example:

25

​
opted_out_users
object[]
required

Users who have opted out of this introduction