List contacts with filtering and pagination

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

import requests

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

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}/contacts', 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}/contacts",
  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}/contacts"

	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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts")

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

{
  "contacts": [
    {
      "id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
      "workspaceId": "92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5",
      "type": "NORMAL",
      "createdAt": "2003-04-10T08:00:00.000Z",
      "updatedAt": "2003-04-10T08:00:00.000Z",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "cellphone": "+14084029292",
      "customAttributes": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "languageCode": "EN",
      "ownerId": "37673840-6259-40f9-bbe5-a7db40f8e3cf"
    }
  ],
  "cursor": "<string>"
}

GET

bridge

api

workspaces

{workspaceId}

contacts

List contacts with filtering and pagination

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

import requests

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

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}/contacts', 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}/contacts",
  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}/contacts"

	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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts")

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

{
  "contacts": [
    {
      "id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
      "workspaceId": "92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5",
      "type": "NORMAL",
      "createdAt": "2003-04-10T08:00:00.000Z",
      "updatedAt": "2003-04-10T08:00:00.000Z",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "cellphone": "+14084029292",
      "customAttributes": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "languageCode": "EN",
      "ownerId": "37673840-6259-40f9-bbe5-a7db40f8e3cf"
    }
  ],
  "cursor": "<string>"
}

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"

Query Parameters

ownerEmail

string | null

Filter contacts by owner email address

string | null

Search contacts by name, email, or cellphone

Example:

"John Doe"

limit

integer

default:20

Number of contacts per page

Required range: 1 <= x <= 100

cursor

string | null

Cursor provided on before request to get next page

Response

Successful Response

Response body for listing contacts.

contacts

ContactResponse · object[]

required

Array of contacts.

Show child attributes

cursor

string | null

Cursor to be send on next page.

Health

Conversations API

Messages API

Contacts API

Files API

Custom attributes API

Provider channels API

LeadScout API

Templates API

Internal Users API

List contacts with filtering and pagination

Authorizations

Path Parameters

Query Parameters

Response