API Documentation
Status
Workspaces
Leads
- POSTCreate a lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate a lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Workspaces
Get user workspaces
GET
/
workspaces
Copy
curl --request GET \
--url https://api.breakcold.com/rest/workspaces \
--header 'X-API-KEY: <api-key>'
Copy
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"credits": 123,
"stripe_customer_id": "<string>",
"tracking_domain": "<string>",
"language": "<string>",
"email_in_thread": true,
"twitter_code_challenge": "<string>",
"twitter_code_verifier": "<string>",
"twitter_state": "<string>",
"pipeline_metadata": "<string>",
"team_size": "<string>",
"source": "<string>",
"default_currency": "<string>",
"leads_schema": "<string>"
}
]
Authorizations
Query Parameters
Response
200
application/json
Successful response
The response is of type object[]
.
Copy
curl --request GET \
--url https://api.breakcold.com/rest/workspaces \
--header 'X-API-KEY: <api-key>'
Copy
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"credits": 123,
"stripe_customer_id": "<string>",
"tracking_domain": "<string>",
"language": "<string>",
"email_in_thread": true,
"twitter_code_challenge": "<string>",
"twitter_code_verifier": "<string>",
"twitter_state": "<string>",
"pipeline_metadata": "<string>",
"team_size": "<string>",
"source": "<string>",
"default_currency": "<string>",
"leads_schema": "<string>"
}
]
Assistant
Responses are generated using AI and may contain mistakes.