Get introduction details

curl --request GET \
  --url https://api.doozy.live/v1/introductions/{introductionId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.doozy.live/v1/introductions/{introductionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.doozy.live/v1/introductions/{introductionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.doozy.live/v1/introductions/{introductionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.doozy.live/v1/introductions/{introductionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "introduction",
  "id": "intro_abc123",
  "status": "active",
  "frequency": "weekly",
  "intro_message": "**Welcome!** _Meet your new colleague!_",
  "destination": {
    "type": "slackChannel",
    "slackChannelId": "C1234567890",
    "excludeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "includeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "filters": {
      "groups": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "workLocations": [
        "<string>"
      ],
      "excludeUsers": [
        "<string>"
      ]
    }
  },
  "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",
  "next_match_at": "2024-02-01T09:00:00.000Z",
  "next_notify_at": "2024-01-31T09:00:00.000Z",
  "meta": {
    "permissions": {
      "can_view_results": true,
      "can_clone": true,
      "can_manage": true,
      "can_edit": true,
      "can_pause": true,
      "can_resume": true,
      "can_delete": true,
      "can_activate": true,
      "can_manage_admins": true
    }
  },
  "type": "group",
  "group_size": 2,
  "time": "10:00",
  "timezone": "Europe/London",
  "other_destination": {
    "type": "slackChannel",
    "slackChannelId": "C1234567890",
    "excludeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "includeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "filters": {
      "groups": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "workLocations": [
        "<string>"
      ],
      "excludeUsers": [
        "<string>"
      ]
    }
  },
  "notify_channel_of_matches": false,
  "upcoming_match_notification": "private_message",
  "enable_opt_out": true,
  "total_reminders_to_send": 2,
  "allowed_meeting_locations": [],
  "slack_users_to_exclude": [
    "<string>"
  ],
  "auto_schedule": {
    "enabled": true,
    "window": "next_3_days"
  },
  "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",
      "opted_out_at": "2026-07-18T10:30:00.000Z"
    }
  ],
  "admin_users": [
    "user_abc123",
    "user_def456"
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

GET

introductions

{introductionId}

Get introduction details

curl --request GET \
  --url https://api.doozy.live/v1/introductions/{introductionId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.doozy.live/v1/introductions/{introductionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.doozy.live/v1/introductions/{introductionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.doozy.live/v1/introductions/{introductionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.doozy.live/v1/introductions/{introductionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "introduction",
  "id": "intro_abc123",
  "status": "active",
  "frequency": "weekly",
  "intro_message": "**Welcome!** _Meet your new colleague!_",
  "destination": {
    "type": "slackChannel",
    "slackChannelId": "C1234567890",
    "excludeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "includeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "filters": {
      "groups": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "workLocations": [
        "<string>"
      ],
      "excludeUsers": [
        "<string>"
      ]
    }
  },
  "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",
  "next_match_at": "2024-02-01T09:00:00.000Z",
  "next_notify_at": "2024-01-31T09:00:00.000Z",
  "meta": {
    "permissions": {
      "can_view_results": true,
      "can_clone": true,
      "can_manage": true,
      "can_edit": true,
      "can_pause": true,
      "can_resume": true,
      "can_delete": true,
      "can_activate": true,
      "can_manage_admins": true
    }
  },
  "type": "group",
  "group_size": 2,
  "time": "10:00",
  "timezone": "Europe/London",
  "other_destination": {
    "type": "slackChannel",
    "slackChannelId": "C1234567890",
    "excludeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "includeUserWithValues": [
      {
        "key": "team",
        "value": "Engineering",
        "matchMethod": "equals"
      }
    ],
    "filters": {
      "groups": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "workLocations": [
        "<string>"
      ],
      "excludeUsers": [
        "<string>"
      ]
    }
  },
  "notify_channel_of_matches": false,
  "upcoming_match_notification": "private_message",
  "enable_opt_out": true,
  "total_reminders_to_send": 2,
  "allowed_meeting_locations": [],
  "slack_users_to_exclude": [
    "<string>"
  ],
  "auto_schedule": {
    "enabled": true,
    "window": "next_3_days"
  },
  "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",
      "opted_out_at": "2026-07-18T10:30:00.000Z"
    }
  ],
  "admin_users": [
    "user_abc123",
    "user_def456"
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such quiz: quiz_abc123",
    "param": "id",
    "doc_url": "https://docs.doozy.live/api/errors#resource_not_found"
  }
}

Authorizations

x-api-key

string

header

required

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

Path Parameters

introductionId

string

required

Introduction ID

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

Example:

"intro_abc123"

Response

Introduction details

Option 1
Option 2

object

enum<string>

required

Object type identifier

Available options:

introduction

Example:

"introduction"

string

required

Unique introduction identifier

Example:

"intro_abc123"

status

enum<string>

required

Current status

Available options:

active,

paused,

complete

Example:

"active"

frequency

enum<string>

required

How often introductions occur

Available options:

once,

weekly,

biweekly,

triweekly,

monthly,

monthlyNthWeekday,

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

Show child attributes

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"

next_match_at

string | null

required

ISO 8601 timestamp of the next scheduled match

Example:

"2024-02-01T09:00:00.000Z"

next_notify_at

string | null

required

ISO 8601 timestamp of the next notification before match

Example:

"2024-01-31T09:00:00.000Z"

Getting Started

Integrations

API reference

Get introduction details

Authorizations

Path Parameters

Response