Get conversation by id

curl --request GET \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}', 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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}",
  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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}")

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

{
  "id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
  "workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
  "participants": {
    "externals": [
      {
        "identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
        "identifierType": "EMAIL",
        "role": "EXTERNAL",
        "joinedAt": "2004-04-10T09:00:00.000Z",
        "lastSeenAt": null
      }
    ],
    "internals": [
      {
        "identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
        "identifierType": "EMAIL",
        "role": "EXTERNAL",
        "joinedAt": "2004-04-10T09:00:00.000Z",
        "lastSeenAt": null
      }
    ]
  },
  "createdAt": "2003-04-10T09:00:00.000Z",
  "updatedAt": "2003-04-10T09:00:00.000Z",
  "name": "Bridge Support Team",
  "status": "ACTIVE"
}

GET

bridge

api

workspaces

{workspaceId}

conversations

{conversationId}

Get conversation by id

curl --request GET \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}', 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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}",
  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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}")

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

{
  "id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
  "workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
  "participants": {
    "externals": [
      {
        "identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
        "identifierType": "EMAIL",
        "role": "EXTERNAL",
        "joinedAt": "2004-04-10T09:00:00.000Z",
        "lastSeenAt": null
      }
    ],
    "internals": [
      {
        "identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
        "identifierType": "EMAIL",
        "role": "EXTERNAL",
        "joinedAt": "2004-04-10T09:00:00.000Z",
        "lastSeenAt": null
      }
    ]
  },
  "createdAt": "2003-04-10T09:00:00.000Z",
  "updatedAt": "2003-04-10T09:00:00.000Z",
  "name": "Bridge Support Team",
  "status": "ACTIVE"
}

Authorizations

x-api-key

string

header

required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId

string<uuid>

required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

conversationId

string<uuid>

required

Unique identifier of the conversation (UUID v4).

Example:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Response

Successful Response

Response body for conversation details.

string

required

Unique identifier of the conversation (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

workspaceId

string

required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

participants

Participants · object

required

Participants of the conversation.

Show child attributes

createdAt

string<date-time>

required

Timestamp when the conversation was created.

Example:

"2003-04-10T09:00:00.000Z"

updatedAt

string<date-time>

required

Timestamp when the conversation was last updated.

Example:

"2003-04-10T09:00:00.000Z"

name

string | null

Optional name/title for the conversation.

Example:

"Bridge Support Team"

status

enum<string> | null

Current conversation status - 'ACTIVE' for visible conversations, 'GHOST' for invisible until first interaction.

Available options:

ACTIVE,

GHOST,

RELEASED,

NOT_ASSIGNED_TO_HUMAN,

BLOCKED

Example:

"ACTIVE"

Health

Conversations API

Messages API

Contacts API

Files API

Custom attributes API

Provider channels API

LeadScout API

Templates API

Internal Users API

Authorizations

Path Parameters

Response