Skip to main content
GET
/
v1
/
workspaces
/
{workspaceId}
/
contacts
List contacts with filtering and pagination
curl --request GET \
  --url https://api.bridge.new/v1/workspaces/{workspaceId}/contacts \
  --header 'X-API-Key: <api-key>'
{
  "contacts": [
    {
      "id": "contact_abc123",
      "workspaceId": "ws_abc123",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "cellphone": "+1-555-123-4567",
      "customAttributes": [
        {
          "key": "company",
          "value": "Acme Corp"
        }
      ],
      "ownerId": "salesperson@your-company.com",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key authentication for machine-to-machine communication.

Authentication Process:

  1. Generate an access key and secret key pair from your Bridge dashboard
  2. Include the access key in the X-API-Key header
  3. Sign your requests using the secret key (HMAC-SHA256)
  4. Include the signature in the X-API-Signature header

Request Signing:

  • Create a string to sign: {HTTP_METHOD}\n{REQUEST_PATH}\n{REQUEST_BODY}\n{TIMESTAMP}
  • Generate HMAC-SHA256 signature using your secret key
  • Include timestamp in X-API-Timestamp header (Unix timestamp)
  • Include signature in X-API-Signature header

Example Headers:

X-API-Key: ak_1234567890abcdef
X-API-Timestamp: 1642234567
X-API-Signature: a1b2c3d4e5f6...

Path Parameters

​
workspaceId
string
required

Unique identifier of the workspace

Example:

"ws_abc123"

Query Parameters

​
ownerId
string<email>

Filter contacts by owner email address

Example:

"salesperson@your-company.com"

​
search
string

Search contacts by name, email, or cellphone

Example:

"John Doe"

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
limit
integer
default:20

Number of contacts per page

Required range: 10 <= x <= 100
Example:

20

Response

Contacts retrieved successfully

​
contacts
object[]
required

Array of contacts

​
pagination
object
required
⌘I