Crossing Edge API
Read and change your CRM from your own systems.
Quickstart
https://api.crossingedge.com/v1Send your key as Authorization: Bearer ce_live_…. Make one in Settings › Integrations › API. Keys are for servers only.
curl https://api.crossingedge.com/v1/me \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/me", {
headers: { Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}` },
});
console.log(await res.json());import os, requests
res = requests.get("https://api.crossingedge.com/v1/me",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"})
print(res.json())Errors
{ "error": { "type", "code", "message", "field", "request_id" } }
| 400 | Invalid request; field names the problem |
| 401 | Missing, revoked or expired key |
| 403 | The key may not do this |
| 404 | Not found |
| 409 | Conflict, like a duplicate email |
| 429 | Rate limited; wait Retry-After seconds |
Limits and retries
120 requests a minute and 25,000 a day per key. Send an Idempotency-Key header on writes: a retry with the same key runs once.
Outgoing webhooks
Get the workspace's events as they happen. Make a sending webhook in Settings › Integrations › Webhooks or with create_outgoing_webhook, pick its events (list_webhook_events) and, if you like, which kinds of record (your own objects too), and Crossing Edge POSTs each one to your https address within a minute.
{ "id", "type": "deal.won", "at", "workspace", "actor": { "kind", "id", "name" }, "object", "objectName", "record": { … }, "changes": [ … ] }
Answer with any 2xx. Anything else is tried again at 1 m, 5 m, 30 m, 2 h, 6 h and 12 h. X-CrossingEdge-Delivery stays the same across tries, so use it to skip repeats. Check X-CrossingEdge-Signature against an HMAC-SHA256 of timestamp.body with your signing secret.
curl https://api.crossingedge.com/v1/actions/create_outgoing_webhook \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Won deals","url":"https://example.com/hook","events":["deal.won"],"confirm":true}'import crypto from "node:crypto";
function fromCrossingEdge(req, rawBody, secret) {
const ts = req.headers["x-crossingedge-timestamp"];
const want = "v1=" + crypto.createHmac("sha256", secret).update(`${ts}.${rawBody}`).digest("hex");
const got = req.headers["x-crossingedge-signature"] ?? "";
return got.length === want.length && crypto.timingSafeEqual(Buffer.from(got), Buffer.from(want));
}import hashlib, hmac
def from_crossing_edge(headers, raw_body: bytes, secret: str) -> bool:
ts = headers["X-CrossingEdge-Timestamp"]
want = "v1=" + hmac.new(secret.encode(), f"{ts}.".encode() + raw_body, hashlib.sha256).hexdigest()
return hmac.compare_digest(headers.get("X-CrossingEdge-Signature", ""), want)Getting started
/meThe key in use
Which key this is, its scope, the workspace it works in, and the member it acts as.
curl -X GET "https://api.crossingedge.com/v1/me" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/me", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/me",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Contacts
/contactsList or search contacts
Finds contacts by name, email, phone, job title or company, optionally narrowed by status or owner.
Query parameters
querystringWords to match in the name, email, phone, job title or company names
statusstringOnly this lifecycle status
ownerstringOnly contacts this member owns, by email or name
companyIdnumberOnly contacts at this company
limitnumberHow many to return, default 20, at most 100
curl -X GET "https://api.crossingedge.com/v1/contacts" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/contacts", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/contacts",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/contactsCreate a contact
Adds a contact.
Body
firstNamestringrequiredFirst name
lastNamestringLast name
emailstringEmail. A contact needs an email or a phone
phonestringPhone, with country code
jobTitlestringJob title
statusstringLifecycle status, one of the choices get_schema lists for contacts.status
sourcestringWhere they came from, one of the choices get_schema lists for contacts.source
linkedinstringLinkedIn profile URL
telegramstringTelegram username, like @priya
countrystringCountry they are based in, by name or two-letter code (India, IN)
statestringTheir state, province or region
citystringTheir city
ownerstringOwner, by member email or name
companyIdsarray of numberCompanies they work with, by id (replaces the current set)
companyNamestringA company to link by exact name; made if the workspace has none by that name
customobjectCustom field values by field key (keys from get_schema)
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/contacts" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"firstName": "Priya"
}'const res = await fetch("https://api.crossingedge.com/v1/contacts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"firstName": "Priya"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/contacts",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"firstName": "Priya"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/contacts/{id}Get a contact
Everything about one contact: their fields, companies, owner, and their latest activities and open tasks.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/contacts/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/contacts/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/contacts/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/contacts/{id}Update a contact
Changes a contact.
Path parameters
idstringrequiredThe record id
Body
firstNamestringFirst name
lastNamestringLast name
emailstringEmail. A contact needs an email or a phone
phonestringPhone, with country code
jobTitlestringJob title
statusstringLifecycle status, one of the choices get_schema lists for contacts.status
sourcestringWhere they came from, one of the choices get_schema lists for contacts.source
linkedinstringLinkedIn profile URL
telegramstringTelegram username, like @priya
countrystringCountry they are based in, by name or two-letter code (India, IN)
statestringTheir state, province or region
citystringTheir city
ownerstringOwner, by member email or name
companyIdsarray of numberCompanies they work with, by id (replaces the current set)
companyNamestringA company to link by exact name; made if the workspace has none by that name
customobjectCustom field values by field key (keys from get_schema)
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X PATCH "https://api.crossingedge.com/v1/contacts/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"firstName": "Priya",
"lastName": "Nair"
}'const res = await fetch("https://api.crossingedge.com/v1/contacts/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"firstName": "Priya",
"lastName": "Nair"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/contacts/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"firstName": "Priya",
"lastName": "Nair"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/contacts/{id}Delete a contact
Deletes a contact for good, with their notes and history.
Path parameters
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/contacts/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/contacts/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/contacts/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/contacts/{id}/stage-timesThe stages of a contact: each stay with when it came in, when it left and for how long
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/contacts/101/stage-times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/contacts/101/stage-times", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/contacts/101/stage-times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Companies
/companiesList or search companies
Finds records of any object (companies, deals, contacts, products or a workspace object) by words in their name and fields, optionally narrowed by owner.
Query parameters
querystringWords to match
ownerstringOnly records this member owns, by email or name
limitnumberHow many, default 20, at most 100
curl -X GET "https://api.crossingedge.com/v1/companies" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/companies", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/companies",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/companiesCreate a company
Adds a record of any object: a company, a deal (lands in the default pipeline unless pipeline or stage is given), a contact, or a workspace object.
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X POST "https://api.crossingedge.com/v1/companies" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"domain": "acme.com"
}'const res = await fetch("https://api.crossingedge.com/v1/companies", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"domain": "acme.com"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/companies",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"domain": "acme.com"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/companies/{id}Get a company
Everything about one record of any object: its fields, what it is linked to (companies, people, deals, parents and subsidiaries, workspace relationships), and its latest activity and notes.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/companies/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/companies/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/companies/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/companies/{id}Update a company
Changes a record of any object.
Path parameters
idstringrequiredThe record id
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X PATCH "https://api.crossingedge.com/v1/companies/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"domain": "acme.com"
}'const res = await fetch("https://api.crossingedge.com/v1/companies/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"domain": "acme.com"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/companies/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"domain": "acme.com"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/companies/{id}Delete a company
Deletes a record of any object for good, with its notes and history.
Path parameters
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/companies/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/companies/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/companies/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/companies/{id}/stage-timesThe stages of a company: each stay with when it came in, when it left and for how long
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/companies/101/stage-times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/companies/101/stage-times", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/companies/101/stage-times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Find
/findWhat Find can fill, its prices in credits, and the credits left
What Find can fill in this workspace, the credits each field costs when found, and the credits left this month.
curl -X GET "https://api.crossingedge.com/v1/find" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/find", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/find",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/contacts/{id}/findFill a contact’s empty fields from outside data sources
Fills empty fields on one contact or company from outside data sources (Find): a work email, mobile number, job title, LinkedIn or location for a contact; phone, company size, industry, location or LinkedIn for a company.
Path parameters
idstringrequiredThe record id
Body
objectstringrequiredcontacts or companies
fieldsarray of stringrequiredThe empty fields to fill, by key (email, phone, jobTitle, linkedin, city, companySize, industry…)
curl -X POST "https://api.crossingedge.com/v1/contacts/101/find" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/contacts/101/find", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/contacts/101/find",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/companies/{id}/findFill a company’s empty fields from outside data sources
Fills empty fields on one contact or company from outside data sources (Find): a work email, mobile number, job title, LinkedIn or location for a contact; phone, company size, industry, location or LinkedIn for a company.
Path parameters
idstringrequiredThe record id
Body
objectstringrequiredcontacts or companies
fieldsarray of stringrequiredThe empty fields to fill, by key (email, phone, jobTitle, linkedin, city, companySize, industry…)
curl -X POST "https://api.crossingedge.com/v1/companies/101/find" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/companies/101/find", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/companies/101/find",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/find/bulkFind missing details on many contacts or companies
Queues Find for up to 200 contacts or companies at once, for the fields named; the finds run in the background over the next minutes and write as they find.
Body
objectstringrequiredcontacts or companies
idsarray of numberrequiredRecord ids, up to 200
fieldsarray of stringrequiredField keys to fill
curl -X POST "https://api.crossingedge.com/v1/find/bulk" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"ids": [],
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/find/bulk", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"ids": [],
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/find/bulk",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"ids": [],
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Deals
/dealsList or search deals
Finds records of any object (companies, deals, contacts, products or a workspace object) by words in their name and fields, optionally narrowed by owner.
Query parameters
querystringWords to match
ownerstringOnly records this member owns, by email or name
limitnumberHow many, default 20, at most 100
curl -X GET "https://api.crossingedge.com/v1/deals" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/deals", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/deals",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/dealsCreate a deal
Adds a record of any object: a company, a deal (lands in the default pipeline unless pipeline or stage is given), a contact, or a workspace object.
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X POST "https://api.crossingedge.com/v1/deals" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
}'const res = await fetch("https://api.crossingedge.com/v1/deals", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/deals",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}Get a deal
Everything about one record of any object: its fields, what it is linked to (companies, people, deals, parents and subsidiaries, workspace relationships), and its latest activity and notes.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/deals/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/deals/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/deals/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}Update a deal
Changes a record of any object.
Path parameters
idstringrequiredThe record id
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X PATCH "https://api.crossingedge.com/v1/deals/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
}'const res = await fetch("https://api.crossingedge.com/v1/deals/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/deals/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme renewal",
"amount": 12000,
"stage": "Proposal"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}Delete a deal
Deletes a record of any object for good, with its notes and history.
Path parameters
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/deals/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/deals/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/deals/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}/stage-timesThe stages of a deal: each stay with when it came in, when it left and for how long
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/deals/101/stage-times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/deals/101/stage-times", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/deals/101/stage-times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Products
/productsList or search products
Finds records of any object (companies, deals, contacts, products or a workspace object) by words in their name and fields, optionally narrowed by owner.
Query parameters
querystringWords to match
ownerstringOnly records this member owns, by email or name
limitnumberHow many, default 20, at most 100
curl -X GET "https://api.crossingedge.com/v1/products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/productsCreate a product
Adds a record of any object: a company, a deal (lands in the default pipeline unless pipeline or stage is given), a contact, or a workspace object.
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X POST "https://api.crossingedge.com/v1/products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Example"
}'const res = await fetch("https://api.crossingedge.com/v1/products", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Example"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Example"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}Get a product
Everything about one record of any object: its fields, what it is linked to (companies, people, deals, parents and subsidiaries, workspace relationships), and its latest activity and notes.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/products/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}Update a product
Changes a record of any object.
Path parameters
idstringrequiredThe record id
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X PATCH "https://api.crossingedge.com/v1/products/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Example"
}'const res = await fetch("https://api.crossingedge.com/v1/products/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Example"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/products/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Example"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}Delete a product
Deletes a record of any object for good, with its notes and history.
Path parameters
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/products/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/products/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/stage-timesThe stages of a product: each stay with when it came in, when it left and for how long
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/products/101/stage-times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101/stage-times", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101/stage-times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Products and stock
/products/{id}/usageHow a product is selling across deals
How a product is selling, over the deals you can see: open deals and units by stage with their value, units won and the revenue from them (this product’s lines only), lost deals, the companies and contacts buying most of it, and the latest deals.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/products/101/usage" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101/usage", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101/usage",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}/productsSet a deal’s products; its amount becomes their total
Sets the products on a deal: products replaces the whole list (an empty list takes them all off).
Path parameters
idstringrequiredThe record id
Body
dealnumberrequiredDeal id
productsarray of objectrequiredThe deal’s products, in order
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/deals/101/products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101,
"products": []
}'const res = await fetch("https://api.crossingedge.com/v1/deals/101/products", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101,
"products": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/deals/101/products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101,
"products": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/price-booksList price books, with the companies and products each covers
Lists the workspace’s price books (the columns of a product’s prices): name, whether it is the default, any rule that picks its companies, how many companies it matches and how many products it prices.
curl -X GET "https://api.crossingedge.com/v1/price-books" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/price-books", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/price-books",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/price-booksAdd a price book, optionally with a company rule
Adds a price book.
Body
namestringrequiredBook name, e.g. Wholesale
ruleFieldstringCompany select field key the rule reads
ruleValuestringThe choice that picks this book
isDefaultbooleanMake it the default book
curl -X POST "https://api.crossingedge.com/v1/price-books" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/price-books", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/price-books",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/price-books/{id}Rename a price book, change its rule or make it the default
Renames a price book, changes its company rule (send ruleField and ruleValue as null to remove it), or makes it the default.
Path parameters
idstringrequiredThe record id
Body
bookstringrequiredPrice book name or id
namestringNew name
ruleFieldstringCompany select field key, or null for no rule
ruleValuestringThe choice, or null
isDefaultbooleanMake it the default book
curl -X PATCH "https://api.crossingedge.com/v1/price-books/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/price-books/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/price-books/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/price-books/{id}/archiveArchive a price book; its prices stay on the lines already quoted
Archives a price book: no longer offered or matched, while its prices stay for the deal lines already quoted from it.
Path parameters
idstringrequiredThe record id
Body
bookstringrequiredPrice book name or id
curl -X POST "https://api.crossingedge.com/v1/price-books/101/archive" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/price-books/101/archive", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/price-books/101/archive",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/pricesA product’s variants, price books and the price in each box
A product’s rate card: its variants, the price books, and the price in each box in words (variant by book), plus its base price and cost (a variant with its own cost uses that).
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/products/101/prices" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101/prices", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101/prices",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/pricesSet (or clear) the price of a product or variant in a price book
Sets one box of a product’s rate card: the price of a product, or of one of its variants, in a price book.
Path parameters
idstringrequiredThe record id
Body
productstringrequiredProduct name, code or id
variantstringVariant name, code or id; leave out for a product without variants
bookstringrequiredPrice book name or id
ratesobjectThe price: Six models, each with its fields: unit {model:"unit", price} (one rate for every unit); volume {model:"volume", bands:[{from,rate}]} (the total quantity picks one rate for all units); tiered {model:"tiered", bands:[{from,rate}]} (each band of units at its own rate); stairstep {model:"stairstep", steps:[{from,to,total}]} (a fixed total for each band, "to" null for the last); package {model:"package", size, price} (a price per pack of size); cost {model:"cost", markup} (the variant’s cost, else the product’s, plus a markup percent). Bands start at 1 and each starts after the one before.
clearbooleanTake the price away instead of setting one
curl -X PUT "https://api.crossingedge.com/v1/products/101/prices" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/products/101/prices", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.put(
"https://api.crossingedge.com/v1/products/101/prices",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/variantsSet a product’s variants as the whole list
Sets a product’s variants (sizes, colours) as the whole list: one with an id keeps its prices and may be renamed; one without an id is new; one left out is removed (archived instead if it is on a deal).
Path parameters
idstringrequiredThe record id
Body
productstringrequiredProduct name, code or id
variantsarray of objectrequiredThe whole list of variants, in order
curl -X PUT "https://api.crossingedge.com/v1/products/101/variants" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"variants": []
}'const res = await fetch("https://api.crossingedge.com/v1/products/101/variants", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"variants": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.put(
"https://api.crossingedge.com/v1/products/101/variants",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"variants": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/quoteWork out the price of a quantity from the rate card, step by step
Works out the price of a quantity of a product from its rate card, step by step: the total, the price each and how it was worked out.
Path parameters
idstringrequiredThe record id
Query parameters
variantstringVariant name, code or id
bookstringPrice book name or id; the default book when left out
qtynumberHow many, above zero
curl -X GET "https://api.crossingedge.com/v1/products/101/quote" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101/quote", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101/quote",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}/price-bookPick a deal’s price book and price its card-priced lines from it
Picks the price book a deal uses (by name or id) and prices its card-priced lines from it; lines with a typed price keep it.
Path parameters
idstringrequiredThe record id
Body
dealnumberrequiredDeal id
bookstringrequiredPrice book name or id
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X PUT "https://api.crossingedge.com/v1/deals/101/price-book" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101,
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/deals/101/price-book", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101,
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.put(
"https://api.crossingedge.com/v1/deals/101/price-book",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101,
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/deals/{id}/products/repricePrice a deal’s card-priced lines again from today’s rates
Prices a deal’s card-priced lines again from today’s rate card in the deal’s price book ("use new prices"); lines with a typed price stay as they are.
Path parameters
idstringrequiredThe record id
Body
dealnumberrequiredDeal id
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/deals/101/products/reprice" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101
}'const res = await fetch("https://api.crossingedge.com/v1/deals/101/products/reprice", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/deals/101/products/reprice",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/products/{id}/stockA product’s stock per warehouse, and per variant
A product’s stock: on hand in each warehouse, the total, whether it is under its reorder level, and with history: true its latest stock changes.
Path parameters
idstringrequiredThe record id
Query parameters
historybooleanAlso the latest 20 stock changes
variantstringOptional: one variant’s stock, by name, code or id ("not split" for stock not split by variant)
curl -X GET "https://api.crossingedge.com/v1/products/101/stock" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/products/101/stock", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/products/101/stock",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/stockRecord stock: opening, received, out, transfer or adjustment
Records stock for a product: kind opening (a first count), received (came in), out (left, say why), transfer (warehouse to toWarehouse) or adjustment (countTo: what is there now, or changeBy: plus or minus).
Body
productstringrequiredProduct name, code or id
variantstringThe variant, by name, code or id: needed when the product has variants. "not split" for stock not split by variant
kindstringrequiredWhat happened
One of opening received out transfer adjustment
warehousestringWarehouse name or code (for a transfer, where it comes from). The default when left out
toWarehousestringTransfer only: where it goes
toVariantstringTransfer only: the variant stock not split by variant is moved onto
qtynumberHow many, above zero (not for an adjustment)
countTonumberAdjustment: what is there now
changeBynumberAdjustment: plus or minus this many
reasonstringWhy, in a few words
curl -X POST "https://api.crossingedge.com/v1/stock" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"kind": "opening"
}'const res = await fetch("https://api.crossingedge.com/v1/stock", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"kind": "opening"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/stock",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"kind": "opening"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/warehousesList warehouses
The warehouses stock sits in: name, code, city, state, which one is the default, and which are archived.
curl -X GET "https://api.crossingedge.com/v1/warehouses" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/warehouses", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/warehouses",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/warehousesCreate a warehouse
Adds a warehouse.
Body
namestringrequiredIts name, unique in the workspace
codestringA short code, optional
citystringOptional
statestringOptional
curl -X POST "https://api.crossingedge.com/v1/warehouses" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/warehouses", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/warehouses",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_deal_productsSet deal products
Sets the products on a deal: products replaces the whole list (an empty list takes them all off).
Body
dealnumberrequiredDeal id
productsarray of objectrequiredThe deal’s products, in order
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/set_deal_products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101,
"products": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_deal_products", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101,
"products": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_deal_products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101,
"products": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_record_productsSet record products
Sets the products on a contact, company or workspace object record, for objects the workspace has related to Products (deals use set_deal_products).
Body
objectstringrequiredcontacts, companies, or a workspace object by id, name or plural
idnumberrequiredRecord id
productsarray of objectrequiredThe record’s products, in order
curl -X POST "https://api.crossingedge.com/v1/actions/set_record_products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"id": 101,
"products": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_record_products", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"id": 101,
"products": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_record_products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"id": 101,
"products": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_product_usageGet product usage
How a product is selling, over the deals you can see: open deals and units by stage with their value, units won and the revenue from them (this product’s lines only), lost deals, the companies and contacts buying most of it, and the latest deals.
Body
productstringrequiredProduct name, code or id
curl -X POST "https://api.crossingedge.com/v1/actions/get_product_usage" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"product": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_product_usage", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_product_usage",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"product": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_price_booksList price books
Lists the workspace’s price books (the columns of a product’s prices): name, whether it is the default, any rule that picks its companies, how many companies it matches and how many products it prices.
curl -X POST "https://api.crossingedge.com/v1/actions/list_price_books" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_price_books", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_price_books",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_price_bookCreate price book
Adds a price book.
Body
namestringrequiredBook name, e.g. Wholesale
ruleFieldstringCompany select field key the rule reads
ruleValuestringThe choice that picks this book
isDefaultbooleanMake it the default book
curl -X POST "https://api.crossingedge.com/v1/actions/create_price_book" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_price_book", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_price_book",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_price_bookUpdate price book
Renames a price book, changes its company rule (send ruleField and ruleValue as null to remove it), or makes it the default.
Body
bookstringrequiredPrice book name or id
namestringNew name
ruleFieldstringCompany select field key, or null for no rule
ruleValuestringThe choice, or null
isDefaultbooleanMake it the default book
curl -X POST "https://api.crossingedge.com/v1/actions/update_price_book" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_price_book", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_price_book",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_price_bookArchive price book
Archives a price book: no longer offered or matched, while its prices stay for the deal lines already quoted from it.
Body
bookstringrequiredPrice book name or id
curl -X POST "https://api.crossingedge.com/v1/actions/archive_price_book" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_price_book", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_price_book",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_product_pricesGet product prices
A product’s rate card: its variants, the price books, and the price in each box in words (variant by book), plus its base price and cost (a variant with its own cost uses that).
Body
productstringrequiredProduct name, code or id
curl -X POST "https://api.crossingedge.com/v1/actions/get_product_prices" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"product": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_product_prices", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_product_prices",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"product": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_product_variantsSet product variants
Sets a product’s variants (sizes, colours) as the whole list: one with an id keeps its prices and may be renamed; one without an id is new; one left out is removed (archived instead if it is on a deal).
Body
productstringrequiredProduct name, code or id
variantsarray of objectrequiredThe whole list of variants, in order
curl -X POST "https://api.crossingedge.com/v1/actions/set_product_variants" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"variants": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_product_variants", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"variants": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_product_variants",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"variants": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_product_priceSet product price
Sets one box of a product’s rate card: the price of a product, or of one of its variants, in a price book.
Body
productstringrequiredProduct name, code or id
variantstringVariant name, code or id; leave out for a product without variants
bookstringrequiredPrice book name or id
ratesobjectThe price: Six models, each with its fields: unit {model:"unit", price} (one rate for every unit); volume {model:"volume", bands:[{from,rate}]} (the total quantity picks one rate for all units); tiered {model:"tiered", bands:[{from,rate}]} (each band of units at its own rate); stairstep {model:"stairstep", steps:[{from,to,total}]} (a fixed total for each band, "to" null for the last); package {model:"package", size, price} (a price per pack of size); cost {model:"cost", markup} (the variant’s cost, else the product’s, plus a markup percent). Bands start at 1 and each starts after the one before.
clearbooleanTake the price away instead of setting one
curl -X POST "https://api.crossingedge.com/v1/actions/set_product_price" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_product_price", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_product_price",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/quote_priceQuote price
Works out the price of a quantity of a product from its rate card, step by step: the total, the price each and how it was worked out.
Body
productstringrequiredProduct name, code or id
variantstringVariant name, code or id
bookstringPrice book name or id; the default book when left out
qtynumberrequiredHow many, above zero
curl -X POST "https://api.crossingedge.com/v1/actions/quote_price" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"product": "…",
"qty": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/quote_price", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product": "…",
"qty": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/quote_price",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"product": "…",
"qty": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_deal_price_bookSet deal price book
Picks the price book a deal uses (by name or id) and prices its card-priced lines from it; lines with a typed price keep it.
Body
dealnumberrequiredDeal id
bookstringrequiredPrice book name or id
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/set_deal_price_book" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101,
"book": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_deal_price_book", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101,
"book": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_deal_price_book",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101,
"book": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/reprice_deal_productsReprice deal products
Prices a deal’s card-priced lines again from today’s rate card in the deal’s price book ("use new prices"); lines with a typed price stay as they are.
Body
dealnumberrequiredDeal id
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/reprice_deal_products" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/reprice_deal_products", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/reprice_deal_products",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_stockGet stock
A product’s stock: on hand in each warehouse, the total, whether it is under its reorder level, and with history: true its latest stock changes.
Body
productstringrequiredProduct name, code or id
variantstringOptional: one variant’s stock, by name, code or id ("not split" for stock not split by variant)
historybooleanAlso the latest 20 stock changes
curl -X POST "https://api.crossingedge.com/v1/actions/get_stock" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"product": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_stock", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"product": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_stock",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"product": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/record_stockRecord stock
Records stock for a product: kind opening (a first count), received (came in), out (left, say why), transfer (warehouse to toWarehouse) or adjustment (countTo: what is there now, or changeBy: plus or minus).
Body
productstringrequiredProduct name, code or id
variantstringThe variant, by name, code or id: needed when the product has variants. "not split" for stock not split by variant
kindstringrequiredWhat happened
One of opening received out transfer adjustment
warehousestringWarehouse name or code (for a transfer, where it comes from). The default when left out
toWarehousestringTransfer only: where it goes
toVariantstringTransfer only: the variant stock not split by variant is moved onto
qtynumberHow many, above zero (not for an adjustment)
countTonumberAdjustment: what is there now
changeBynumberAdjustment: plus or minus this many
reasonstringWhy, in a few words
curl -X POST "https://api.crossingedge.com/v1/actions/record_stock" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"product": "…",
"kind": "opening"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/record_stock", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"product": "…",
"kind": "opening"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/record_stock",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"product": "…",
"kind": "opening"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Any object
/objects/{object}/recordsList or search records of any object
Finds records of any object (companies, deals, contacts, products or a workspace object) by words in their name and fields, optionally narrowed by owner.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
Query parameters
querystringWords to match
ownerstringOnly records this member owns, by email or name
limitnumberHow many, default 20, at most 100
curl -X GET "https://api.crossingedge.com/v1/objects/deals/records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/objects/deals/records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/objects/{object}/recordsCreate a record
Adds a record of any object: a company, a deal (lands in the default pipeline unless pipeline or stage is given), a contact, or a workspace object.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X POST "https://api.crossingedge.com/v1/objects/deals/records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Example"
}'const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Example"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/objects/deals/records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Example"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/objects/{object}/records/{id}Get a record
Everything about one record of any object: its fields, what it is linked to (companies, people, deals, parents and subsidiaries, workspace relationships), and its latest activity and notes.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/objects/deals/records/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/objects/deals/records/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/objects/{object}/records/{id}Update a record
Changes a record of any object.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
idstringrequiredThe record id
Body
Field values by key or label: name, domain, amount, owner (member email), and custom fields by their label. /schema lists every field and its choices.
curl -X PATCH "https://api.crossingedge.com/v1/objects/deals/records/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Example"
}'const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Example"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/objects/deals/records/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Example"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/objects/{object}/records/{id}Delete a record
Deletes a record of any object for good, with its notes and history.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/objects/deals/records/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/objects/deals/records/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/objects/{object}/records/{id}/stage-timesThe stages of a record: each stay with when it came in, when it left and for how long
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Path parameters
objectstringrequiredThe object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/objects/deals/records/101/stage-times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/objects/deals/records/101/stage-times", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/objects/deals/records/101/stage-times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Tasks
/tasksList what is to do (every kind by default), or other activities by type
Tasks, open ones by default: yours, everyone’s you can see, or those on one record.
Query parameters
scopestringTasks you created or are on (default), or all you can see
statusstringDefault open
typestringDefault: every kind of thing to do (all but notes). "task" is read as other
overduebooleanOnly those past due
dueBeforestringOnly those due before this ISO date
createdAfterstringOnly those made on or after this ISO date
createdBeforestringOnly those made before this ISO date
contactIdnumberThe contact it is about
companyIdnumberThe company it is about
dealIdnumberThe deal it is about
limitnumberDefault 25, at most 100
curl -X GET "https://api.crossingedge.com/v1/tasks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/tasks", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/tasks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/tasksAdd a call, meeting, email, message or other to do, with an optional reminder
Adds something to do: a call, meeting, email, message or other (default), when it is due, who it is for (you by default), the records it is about, and an optional reminder.
Body
subjectstringrequiredWhat needs doing
duestringDue date and time, ISO 8601, e.g. 2026-10-01T17:00:00+05:30. Left out: tomorrow at 9 AM
prioritystringDefault Medium
One of Low Medium High
assigneestringWho owns it, by member email or name. Default: you
bodystringDetails
kindstringWhat it is. Default other ("task" is read as other)
One of call meeting email message other task
reminderstringWhen to remind whoever it is for, by email: at (the due time), before15 (15 minutes before), before30 (30 minutes before), morning (9 AM that day), an ISO time, or none
parentTaskIdstringPut it on the same records as this task
notifyarray of stringPeople to keep informed, by member email or name
contactIdnumberThe contact it is about
companyIdnumberThe company it is about
dealIdnumberThe deal it is about
recordsarray of objectOther records it is about, as { object, id } (custom objects too)
curl -X POST "https://api.crossingedge.com/v1/tasks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"subject": "Call Priya about the renewal"
}'const res = await fetch("https://api.crossingedge.com/v1/tasks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"subject": "Call Priya about the renewal"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/tasks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"subject": "Call Priya about the renewal"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/tasks/{id}Get a task
One task (or any activity).
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/tasks/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/tasks/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/tasks/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/tasks/{id}Update a task
Changes a task or activity.
Path parameters
idstringrequiredThe record id
Body
subjectstringNew subject
bodystringNew details
duestringNew due date, ISO 8601 (tasks), or when it happened (other types)
prioritystringOne of Low Medium High
statusstringOne of planned done cancelled
assigneestringNew owner, by member email or name
notifyarray of stringThe full new list of people to keep informed, by email or name
detailsobjectType fields to change
reminderstringWhen to remind whoever it is for, by email: at (the due time), before15 (15 minutes before), before30 (30 minutes before), morning (9 AM that day), an ISO time, or none
moveIntoTaskstringPut it on the same records as this task
contactIdnumberThe contact it is about. Passing any record replaces what it is linked to
companyIdnumberThe company it is about. Passing any record replaces what it is linked to
dealIdnumberThe deal it is about. Passing any record replaces what it is linked to
recordsarray of objectOther records it is about, as { object, id } (custom objects too). Passing any record replaces what it is linked to
curl -X PATCH "https://api.crossingedge.com/v1/tasks/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"subject": "Call Priya about the renewal",
"body": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/tasks/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"subject": "Call Priya about the renewal",
"body": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/tasks/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"subject": "Call Priya about the renewal",
"body": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/tasks/{id}Delete a task
Deletes a task or activity for good.
Path parameters
idstringrequiredThe record id
curl -X DELETE "https://api.crossingedge.com/v1/tasks/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/tasks/101", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.delete(
"https://api.crossingedge.com/v1/tasks/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"deleted": true
},
"request_id": "req_7c1f0e2a9b4d"
}/tasks/{id}/completeMark it done, with an optional note on how it went
Marks it done.
Path parameters
idstringrequiredThe record id
Body
notestringHow it went, saved as a note on its record
curl -X POST "https://api.crossingedge.com/v1/tasks/101/complete" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"note": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/tasks/101/complete", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"note": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/tasks/101/complete",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"note": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Meetings
/meetingsList meetings: by range, the key maker’s own or the team’s, internal or external, or still to follow up
Meetings from notetakers (Granola, Fireflies, Fathom) and from calendar invites in synced inboxes: title, where it came from, when, who was there (with their answers to the invite), a summary preview, the deal, internal (only the team) or external, cancelled, and the link to join.
Query parameters
qstringWords that must all appear in the title or summary
fromstringOnly meetings starting on or after this date (YYYY-MM-DD or ISO time)
tostringOnly meetings starting on or before this date
scopestringmine: meetings the person is in or brought in; team (default): every meeting they may see
internalbooleantrue: only internal meetings (everyone on the team); false: only those with someone from outside
personnumberOnly meetings this member (user id, from list_members) is in
to_follow_upbooleanOnly past external meetings with no email to their guests since, and each one’s last email date
prepbooleanAdd each one’s deal stage and when its guests were last emailed
curl -X GET "https://api.crossingedge.com/v1/meetings" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/meetings", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/meetings",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/meetings/{id}Get a meeting: guests and their answers, where it came from, internal, cancelled, the join link, summary and deal
One meeting whole: the notetaker’s full summary, who was there (which are contacts, and each guest’s answer to the invite: accepted, declined, tentative or pending), where it came from (a notetaker or a calendar invite), internal or external, cancelled, the link to join, the records it is on, its deal (or the deals to pick from when it needs one), and a link to open it in the notetaker.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/meetings/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/meetings/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/meetings/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_meetingsList meetings
Meetings from notetakers (Granola, Fireflies, Fathom) and from calendar invites in synced inboxes: title, where it came from, when, who was there (with their answers to the invite), a summary preview, the deal, internal (only the team) or external, cancelled, and the link to join.
Body
recordobjectOnly the meetings on this record
qstringWords that must all appear in the title or summary
fromstringOnly meetings starting on or after this date (YYYY-MM-DD or ISO time)
tostringOnly meetings starting on or before this date
scopestringmine: meetings the person is in or brought in; team (default): every meeting they may see
One of mine team
minebooleanThe same as scope: mine
internalbooleantrue: only internal meetings (everyone on the team); false: only those with someone from outside
personnumberOnly meetings this member (user id, from list_members) is in
to_follow_upbooleanOnly past external meetings with no email to their guests since, and each one’s last email date
prepbooleanAdd each one’s deal stage and when its guests were last emailed
curl -X POST "https://api.crossingedge.com/v1/actions/list_meetings" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"record": {},
"q": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_meetings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"record": {},
"q": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_meetings",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"record": {},
"q": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_meetingGet meeting
One meeting whole: the notetaker’s full summary, who was there (which are contacts, and each guest’s answer to the invite: accepted, declined, tentative or pending), where it came from (a notetaker or a calendar invite), internal or external, cancelled, the link to join, the records it is on, its deal (or the deals to pick from when it needs one), and a link to open it in the notetaker.
Body
idstringrequiredMeeting id, from list_meetings
transcriptbooleanAlso read the transcript (only for the person who recorded it)
curl -X POST "https://api.crossingedge.com/v1/actions/get_meeting" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_meeting", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_meeting",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_meeting_dealSet meeting deal
Puts a meeting on its deal, as picking the deal on the meeting does: one of get_meeting’s dealsToPickFrom or any deal the person can change, by id or name; deal: null takes it off its deal.
Body
idstringrequiredMeeting id, from list_meetings
dealnumber | stringrequiredThe deal’s id or name; null for no deal
curl -X POST "https://api.crossingedge.com/v1/actions/set_meeting_deal" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"deal": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_meeting_deal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"deal": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_meeting_deal",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"deal": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/draft_meeting_follow_upDraft meeting follow-up
Drafts the follow-up email after a meeting in the person’s own style, from its summary, to the people outside the team who were there, as Draft follow-up on the meeting does.
Body
idstringrequiredMeeting id, from list_meetings
changestringTo refine a draft: what to change, in the person’s words
draftstringTo refine: the draft as it stands now
curl -X POST "https://api.crossingedge.com/v1/actions/draft_meeting_follow_up" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/draft_meeting_follow_up", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/draft_meeting_follow_up",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/send_meeting_follow_upSend meeting follow-up
Sends the follow-up email after a meeting from the person’s own Gmail, kept on the meeting’s records, and closes the meeting’s follow-up task, as Send on the meeting does.
Body
idstringrequiredMeeting id, from list_meetings
textstringrequiredThe message, plain text
toarray of stringEmail addresses to send to (default the people outside the team who were there)
ccarray of stringCc addresses
bccarray of stringBcc addresses
subjectstringSubject (default “Following up: ” and the meeting’s title)
inboxstringWhich of the person’s inboxes to send from
confirmbooleanrequiredTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/send_meeting_follow_up" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"text": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/send_meeting_follow_up", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"text": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/send_meeting_follow_up",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"text": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_notetakersGet notetakers
The person’s own notetakers (Granola, Fireflies, Fathom): which are connected, whether each is working, when it last checked and how many meetings it brought in.
curl -X POST "https://api.crossingedge.com/v1/actions/get_notetakers" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_notetakers", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_notetakers",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/check_notetaker_nowCheck notetaker now
Asks the person’s own notetaker for new meetings now, as Check now in Settings › Notetakers does.
Body
notetakerstringrequiredgranola, fireflies or fathom
curl -X POST "https://api.crossingedge.com/v1/actions/check_notetaker_now" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"notetaker": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/check_notetaker_now", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"notetaker": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/check_notetaker_now",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"notetaker": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_notetakerDisconnect notetaker
Disconnects the person’s own notetaker, as Disconnect in Settings › Notetakers does.
Body
notetakerstringrequiredgranola, fireflies or fathom
confirmbooleanrequiredTrue once the person has said disconnect it
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_notetaker" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"notetaker": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_notetaker", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"notetaker": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_notetaker",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"notetaker": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Members
/membersList members with their built-in fields and the member fields the key’s owner may see
The team as an object: every member you may see with their built-in fields (name, email, phone, role, joined, signed in) and the workspace’s own member fields (pay, team, targets and the like) by label, formulas worked out.
curl -X GET "https://api.crossingedge.com/v1/members" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/members", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/members",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/members/{id}Get a member, their fields and the history of changes
One member: their built-in fields, their own fields you may see (by label), and the history of changes to those fields, newest first.
Path parameters
idstringrequiredThe record id
curl -X GET "https://api.crossingedge.com/v1/members/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/members/101", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/members/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/members/{id}Set a member’s own fields by label, such as pay; null clears one
Sets a member’s own fields, such as base salary, variable pay or team: values by field label (or id); null clears one.
Path parameters
idstringrequiredThe record id
Body
memberstringrequiredMember email, name or user id
valuesobjectrequiredField label or id → value, e.g. { "Base salary": 1200000, "Team": "North" }
curl -X PATCH "https://api.crossingedge.com/v1/members/101" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"values": {}
}'const res = await fetch("https://api.crossingedge.com/v1/members/101", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"values": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.patch(
"https://api.crossingedge.com/v1/members/101",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"values": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Schema
/schemaGet the workspace schema: objects, fields and their choices
The workspace data model: every object and field (with types and choices), pipelines and stages, members, currency and today’s date.
curl -X GET "https://api.crossingedge.com/v1/schema" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/schema", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/schema",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Connected apps
/connectionsList connected apps and the tools that are on
The apps connected to this workspace over MCP (Connected apps): each one’s name, address, status (Connected, Sign in again, Key no longer works, Needs more access, Error) and the tools switched on, each marked reads or changes.
curl -X GET "https://api.crossingedge.com/v1/connections" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/connections", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/connections",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/connections/{connection}/toolsA connected app’s tools that are on: what each does, its inputs, reads or changes
What a connected app can do from here: its tools that are switched on, each with what it does, its inputs and whether it only reads (runs straight away) or changes things in the app (the person confirms first).
Path parameters
connectionstringrequiredThe connected app: its id (cn_…) or name, from /connections
curl -X GET "https://api.crossingedge.com/v1/connections/{connection}/tools" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY"const res = await fetch("https://api.crossingedge.com/v1/connections/{connection}/tools", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
},
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.get(
"https://api.crossingedge.com/v1/connections/{connection}/tools",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
)
data = res.json()["data"]{
"data": {
"total": 1,
"…": [
{
"id": 101,
"…": "…"
}
]
},
"request_id": "req_7c1f0e2a9b4d"
}/connections/{connection}/tools/{tool}/callCall one switched-on tool of a connected app; its answer is outside data
Calls one switched-on tool of a connected app with its arguments, with the app’s own sign-in: “what is on my Calendly”, find an issue in Linear, add a row to a sheet.
Path parameters
connectionstringrequiredThe connected app: its id (cn_…) or name, from /connections
toolstringrequiredThe tool’s name, from /connections/{connection}/tools
Body
The tool’s inputs, as /connections/{connection}/tools lists them. Needs a read and write key: a tool may change things in the app.
curl -X POST "https://api.crossingedge.com/v1/connections/{connection}/tools/{tool}/call" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Example"
}'const res = await fetch("https://api.crossingedge.com/v1/connections/{connection}/tools/{tool}/call", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Example"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/connections/{connection}/tools/{tool}/call",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Example"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_connectionsList connected apps
The apps connected to this workspace over MCP (Connected apps): each one’s name, address, status (Connected, Sign in again, Key no longer works, Needs more access, Error) and the tools switched on, each marked reads or changes.
curl -X POST "https://api.crossingedge.com/v1/actions/list_connections" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_connections", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_connections",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/test_connectionTest connected app
Tests a connected app now, as Test in Settings does: signs in, reads its tools again (new ones arrive switched off) and says whether it works.
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
curl -X POST "https://api.crossingedge.com/v1/actions/test_connection" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/test_connection", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/test_connection",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/rename_connectionRename connected app
Renames a connected app, as renaming it in Settings does.
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
namestringrequiredIts new name
curl -X POST "https://api.crossingedge.com/v1/actions/rename_connection" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…",
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/rename_connection", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…",
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/rename_connection",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…",
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_connectionDisconnect connected app
Disconnects a connected app, as Disconnect in Settings does: without confirm it changes nothing and says which agents use it; with confirm: true (after asking the person) the app is asked to forget its sign-in, and the connection and its tools go.
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
confirmbooleanTrue once the person has said disconnect it
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_connection" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_connection", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_connection",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_app_toolsList an app’s tools
What a connected app can do from here: its tools that are switched on, each with what it does, its inputs and whether it only reads (runs straight away) or changes things in the app (the person confirms first).
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
toolstringOnly this tool, by name
curl -X POST "https://api.crossingedge.com/v1/actions/list_app_tools" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"connection": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_app_tools", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"connection": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_app_tools",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"connection": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/use_app_toolUse an app’s tool
Calls one switched-on tool of a connected app with its arguments, with the app’s own sign-in: “what is on my Calendly”, find an issue in Linear, add a row to a sheet.
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
toolstringrequiredThe tool’s name, from list_app_tools
argumentsobjectThe tool’s inputs, as list_app_tools shows them
curl -X POST "https://api.crossingedge.com/v1/actions/use_app_tool" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…",
"tool": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/use_app_tool", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…",
"tool": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/use_app_tool",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…",
"tool": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/switch_app_toolsSwitch app tools on or off
Switches a connected app’s tools on or off, as the switches in Settings do: named tools, or all of them.
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
toolsarray of stringTool names, from list_connections
allbooleanEvery tool the app offers
onbooleanrequiredTrue to switch on, false to switch off
curl -X POST "https://api.crossingedge.com/v1/actions/switch_app_tools" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…",
"on": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/switch_app_tools", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…",
"on": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/switch_app_tools",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…",
"on": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_app_tool_kindMark what an app tool does
Says what a connected app’s tool does when the app gave no hint, as Settings does: reads (it only reads, and runs without asking), changes (it changes things), or default (back to changes).
Body
connectionstringrequiredThe connected app: its id or name, from list_connections
toolstringrequiredThe tool’s name
kindstringrequiredOne of reads changes default
curl -X POST "https://api.crossingedge.com/v1/actions/set_app_tool_kind" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…",
"tool": "…",
"kind": "reads"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_app_tool_kind", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…",
"tool": "…",
"kind": "reads"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_app_tool_kind",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…",
"tool": "…",
"kind": "reads"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/connect_appConnect an app
Connects an app by its MCP address when it needs no sign-in, as adding one in Settings does: its tools arrive switched off.
Body
addressstringrequiredThe app’s MCP address, https://…
namestringWhat to call it (optional)
curl -X POST "https://api.crossingedge.com/v1/actions/connect_app" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"address": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/connect_app", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"address": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/connect_app",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"address": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_integrationsGet integrations
What needs a look across the integrations, as the banner at the top of the app shows it (Gmail or Telegram that stopped, IndiaMART, failing webhooks, and connected apps waiting for a sign-in), each with the page that fixes it, and the page for every integration in Settings.
curl -X POST "https://api.crossingedge.com/v1/actions/get_integrations" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_integrations", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_integrations",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Contacts and tasks
Actions/actions/search_contactsSearch contacts
Finds contacts by name, email, phone, job title or company, optionally narrowed by status or owner.
Body
querystringWords to match in the name, email, phone, job title or company names
statusstringOnly this lifecycle status
ownerstringOnly contacts this member owns, by email or name
companyIdnumberOnly contacts at this company
limitnumberHow many to return, default 20, at most 100
curl -X POST "https://api.crossingedge.com/v1/actions/search_contacts" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "acme",
"status": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/search_contacts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "acme",
"status": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/search_contacts",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"query": "acme",
"status": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_contactGet contact
Everything about one contact: their fields, companies, owner, and their latest activities and open tasks.
Body
idnumberrequiredContact id
curl -X POST "https://api.crossingedge.com/v1/actions/get_contact" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_contact", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_contact",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_contactCreate contact
Adds a contact.
Body
firstNamestringrequiredFirst name
lastNamestringLast name
emailstringEmail. A contact needs an email or a phone
phonestringPhone, with country code
jobTitlestringJob title
statusstringLifecycle status, one of the choices get_schema lists for contacts.status
sourcestringWhere they came from, one of the choices get_schema lists for contacts.source
linkedinstringLinkedIn profile URL
telegramstringTelegram username, like @priya
countrystringCountry they are based in, by name or two-letter code (India, IN)
statestringTheir state, province or region
citystringTheir city
ownerstringOwner, by member email or name
companyIdsarray of numberCompanies they work with, by id (replaces the current set)
companyNamestringA company to link by exact name; made if the workspace has none by that name
customobjectCustom field values by field key (keys from get_schema)
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/create_contact" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"firstName": "Priya"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_contact", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"firstName": "Priya"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_contact",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"firstName": "Priya"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_contactUpdate contact
Changes a contact.
Body
idnumberrequiredContact id
firstNamestringFirst name
lastNamestringLast name
emailstringEmail. A contact needs an email or a phone
phonestringPhone, with country code
jobTitlestringJob title
statusstringLifecycle status, one of the choices get_schema lists for contacts.status
sourcestringWhere they came from, one of the choices get_schema lists for contacts.source
linkedinstringLinkedIn profile URL
telegramstringTelegram username, like @priya
countrystringCountry they are based in, by name or two-letter code (India, IN)
statestringTheir state, province or region
citystringTheir city
ownerstringOwner, by member email or name
companyIdsarray of numberCompanies they work with, by id (replaces the current set)
companyNamestringA company to link by exact name; made if the workspace has none by that name
customobjectCustom field values by field key (keys from get_schema)
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/update_contact" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_contact", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_contact",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_contactDelete contact
Deletes a contact for good, with their notes and history.
Body
idnumberrequiredContact id
confirmbooleanrequiredTrue once the person has confirmed the delete
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/delete_contact" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": 101,
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_contact", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": 101,
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_contact",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": 101,
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_tasksList tasks
Tasks, open ones by default: yours, everyone’s you can see, or those on one record.
Body
scopestringTasks you created or are on (default), or all you can see
One of mine all
statusstringDefault open
One of open done all
typestringDefault: every kind of thing to do (all but notes). "task" is read as other
One of call meeting email message other note any task
overduebooleanOnly those past due
dueBeforestringOnly those due before this ISO date
createdAfterstringOnly those made on or after this ISO date
createdBeforestringOnly those made before this ISO date
contactIdnumberThe contact it is about
companyIdnumberThe company it is about
dealIdnumberThe deal it is about
recordsarray of objectOther records it is about, as { object, id } (custom objects too)
limitnumberDefault 25, at most 100
curl -X POST "https://api.crossingedge.com/v1/actions/list_tasks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"scope": "mine",
"status": "open"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_tasks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"scope": "mine",
"status": "open"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_tasks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"scope": "mine",
"status": "open"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_taskGet task
One task (or any activity).
Body
idstringrequiredTask id, like act_…
curl -X POST "https://api.crossingedge.com/v1/actions/get_task" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_task", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_task",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_taskCreate task
Adds something to do: a call, meeting, email, message or other (default), when it is due, who it is for (you by default), the records it is about, and an optional reminder.
Body
subjectstringrequiredWhat needs doing
duestringDue date and time, ISO 8601, e.g. 2026-10-01T17:00:00+05:30. Left out: tomorrow at 9 AM
prioritystringDefault Medium
One of Low Medium High
assigneestringWho owns it, by member email or name. Default: you
bodystringDetails
kindstringWhat it is. Default other ("task" is read as other)
One of call meeting email message other task
reminderstringWhen to remind whoever it is for, by email: at (the due time), before15 (15 minutes before), before30 (30 minutes before), morning (9 AM that day), an ISO time, or none
parentTaskIdstringPut it on the same records as this task
notifyarray of stringPeople to keep informed, by member email or name
contactIdnumberThe contact it is about
companyIdnumberThe company it is about
dealIdnumberThe deal it is about
recordsarray of objectOther records it is about, as { object, id } (custom objects too)
curl -X POST "https://api.crossingedge.com/v1/actions/create_task" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"subject": "Call Priya about the renewal"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_task", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"subject": "Call Priya about the renewal"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_task",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"subject": "Call Priya about the renewal"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/log_activityLog activity
Logs a call, meeting, email, message or note on records, or on a task's records (taskId).
Body
typestringrequiredOne of call meeting email message note
subjectstringShort title
bodystringWhat happened; required for a note
atstringWhen, ISO 8601. Default now. A future time plans a meeting, call, email or message
durationMinutesnumberHow long, for calls and meetings
detailsobjectThis type’s own fields (see the description)
taskIdstringLog it on the same records as this task
notifyarray of stringPeople to keep informed, by member email or name
privatebooleanNotes on a record only: visible to you alone
contactIdnumberThe contact it is about
companyIdnumberThe company it is about
dealIdnumberThe deal it is about
recordsarray of objectOther records it is about, as { object, id } (custom objects too)
curl -X POST "https://api.crossingedge.com/v1/actions/log_activity" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"type": "call"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/log_activity", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"type": "call"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/log_activity",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"type": "call"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_taskUpdate task
Changes a task or activity.
Body
idstringrequiredTask or activity id
subjectstringNew subject
bodystringNew details
duestringNew due date, ISO 8601 (tasks), or when it happened (other types)
prioritystringOne of Low Medium High
statusstringOne of planned done cancelled
assigneestringNew owner, by member email or name
notifyarray of stringThe full new list of people to keep informed, by email or name
detailsobjectType fields to change
reminderstringWhen to remind whoever it is for, by email: at (the due time), before15 (15 minutes before), before30 (30 minutes before), morning (9 AM that day), an ISO time, or none
moveIntoTaskstringPut it on the same records as this task
contactIdnumberThe contact it is about. Passing any record replaces what it is linked to
companyIdnumberThe company it is about. Passing any record replaces what it is linked to
dealIdnumberThe deal it is about. Passing any record replaces what it is linked to
recordsarray of objectOther records it is about, as { object, id } (custom objects too). Passing any record replaces what it is linked to
curl -X POST "https://api.crossingedge.com/v1/actions/update_task" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_task", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_task",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_notesList notes
Every note on one record (a contact, company, deal or a record of any object), newest first and in full: what it says, whether it is private (the person’s own alone), when it was written and edited.
Body
objectstringrequiredcontacts, companies, deals or another object id from get_schema
idnumberrequiredRecord id
limitnumberAt most this many, newest first (default 50, up to 200)
curl -X POST "https://api.crossingedge.com/v1/actions/list_notes" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_notes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_notes",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_noteUpdate note
Changes a note on a record (ids like note_…, from get_contact).
Body
idstringrequiredNote id
bodystringThe new text
privatebooleanVisible to you alone
curl -X POST "https://api.crossingedge.com/v1/actions/update_note" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_note", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_note",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_noteDelete note
Deletes a note on a record for good.
Body
idstringrequiredNote id
confirmbooleanrequiredTrue once the person has confirmed the delete
curl -X POST "https://api.crossingedge.com/v1/actions/delete_note" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_note", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_note",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/complete_taskComplete task
Marks it done.
Body
idstringrequiredTask id
notestringHow it went, saved as a note on its record
curl -X POST "https://api.crossingedge.com/v1/actions/complete_task" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/complete_task", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/complete_task",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/snooze_reminderSnooze reminder
Snoozes a task’s reminder, as Snooze on the task does: until later today (3 hours from now), tomorrow (9 AM) or next week (Monday 9 AM), in the workspace’s time zone.
Body
idstringrequiredTask id
untilstringrequiredlaterToday, tomorrow or nextWeek
One of laterToday tomorrow nextWeek
curl -X POST "https://api.crossingedge.com/v1/actions/snooze_reminder" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"until": "laterToday"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/snooze_reminder", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"until": "laterToday"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/snooze_reminder",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"until": "laterToday"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/no_reply_neededNo reply needed
Closes a reply task (an email, Telegram message or meeting follow-up waiting on the person) as needing no reply, as No reply needed on the task does: the task is cancelled with a note and the conversation stops asking.
Body
idstringrequiredTask id
curl -X POST "https://api.crossingedge.com/v1/actions/no_reply_needed" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/no_reply_needed", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/no_reply_needed",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_taskDelete task
Deletes a task or activity for good.
Body
idstringrequiredTask or activity id
confirmbooleanrequiredTrue once the person has confirmed the delete
curl -X POST "https://api.crossingedge.com/v1/actions/delete_task" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_task", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_task",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Records
Actions/actions/search_recordsSearch records
Finds records of any object (companies, deals, contacts, products or a workspace object) by words in their name and fields, optionally narrowed by owner.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
querystringWords to match
ownerstringOnly records this member owns, by email or name
limitnumberHow many, default 20, at most 100
curl -X POST "https://api.crossingedge.com/v1/actions/search_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/search_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/search_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_recordGet record
Everything about one record of any object: its fields, what it is linked to (companies, people, deals, parents and subsidiaries, workspace relationships), and its latest activity and notes.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
idnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/get_record" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_record", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_record",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_recordCreate record
Adds a record of any object: a company, a deal (lands in the default pipeline unless pipeline or stage is given), a contact, or a workspace object.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
fieldsobjectrequiredField values. Companies: name, domain, industry, companySize, country, state, city, phone, linkedin, icp. Deals: name, amount, closeDate (YYYY-MM-DD), source, nextStep, description, lostReason, pipeline and stage (by name), companyIds, contactIds. Contacts: firstName, lastName, email, phone, jobTitle, status, source, linkedin, telegram, country, state, city, companyIds. Products: name, code, category, unit, price, cost, description, active, trackStock, reorderLevel. Any object: owner (member email or name) and custom: { field label or id: value }. On a workspace object, pass its fields by label directly.
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/create_record" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"fields": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_record", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"fields": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_record",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"fields": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_all_recordsRead all records
Every record of an object this person can see, as one compact table: a column list and one row per record, names instead of ids (owner, pipeline, stage, companies, people), custom fields as their own columns.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
columnsarray of stringOnly these fields, by name (id and name always come)
nextnumberThe next value from the previous page
curl -X POST "https://api.crossingedge.com/v1/actions/read_all_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_all_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_all_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_recordUpdate record
Changes a record of any object.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
idnumberrequiredRecord id
fieldsobjectrequiredField values. Companies: name, domain, industry, companySize, country, state, city, phone, linkedin, icp. Deals: name, amount, closeDate (YYYY-MM-DD), source, nextStep, description, lostReason, pipeline and stage (by name), companyIds, contactIds. Contacts: firstName, lastName, email, phone, jobTitle, status, source, linkedin, telegram, country, state, city, companyIds. Products: name, code, category, unit, price, cost, description, active, trackStock, reorderLevel. Any object: owner (member email or name) and custom: { field label or id: value }. On a workspace object, pass its fields by label directly.
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/update_record" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"id": 101,
"fields": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_record", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"id": 101,
"fields": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_record",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"id": 101,
"fields": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_deal_splitSet deal split
Shares credit on a deal between its owner and other members.
Body
dealnumberrequiredDeal id
membersarray of objectrequiredWho shares credit besides the owner
curl -X POST "https://api.crossingedge.com/v1/actions/set_deal_split" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"deal": 101,
"members": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_deal_split", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"deal": 101,
"members": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_deal_split",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"deal": 101,
"members": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_recordDelete record
Deletes a record of any object for good, with its notes and history.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
idnumberrequiredRecord id
confirmbooleanrequiredTrue once the person has confirmed the delete
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/delete_record" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"id": 101,
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_record", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"id": 101,
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_record",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"id": 101,
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bulk_update_recordsBulk update records
Sets the same field values on many records of one object at once, up to 200 ids per call: an owner, a status, a source, an ICP fit, any field.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
idsarray of numberrequiredRecord ids, at most 200
fieldsobjectrequiredField values. Companies: name, domain, industry, companySize, country, state, city, phone, linkedin, icp. Deals: name, amount, closeDate (YYYY-MM-DD), source, nextStep, description, lostReason, pipeline and stage (by name), companyIds, contactIds. Contacts: firstName, lastName, email, phone, jobTitle, status, source, linkedin, telegram, country, state, city, companyIds. Products: name, code, category, unit, price, cost, description, active, trackStock, reorderLevel. Any object: owner (member email or name) and custom: { field label or id: value }. On a workspace object, pass its fields by label directly.
curl -X POST "https://api.crossingedge.com/v1/actions/bulk_update_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"ids": [],
"fields": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bulk_update_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"ids": [],
"fields": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bulk_update_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"ids": [],
"fields": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bulk_delete_recordsBulk delete records
Deletes many records of one object for good, with their notes and history, up to 200 ids per call.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)
idsarray of numberrequiredRecord ids, at most 200
confirmbooleanrequiredTrue once the person has confirmed the delete
curl -X POST "https://api.crossingedge.com/v1/actions/bulk_delete_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"ids": [],
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bulk_delete_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"ids": [],
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bulk_delete_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"ids": [],
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bulk_update_tasksBulk update tasks
Changes many tasks at once, up to 200 ids per call: mark them done, give them a new assignee (the people they are assigned to are replaced; people kept informed stay), or a new due date.
Body
idsarray of stringrequiredTask ids, at most 200
actionstringrequiredcomplete marks them done; reassign needs assignee; due needs due
One of complete reassign due
assigneestringFor reassign: the new assignee, by member email or name
duestringFor due: the new due date, ISO 8601
curl -X POST "https://api.crossingedge.com/v1/actions/bulk_update_tasks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": [],
"action": "complete"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bulk_update_tasks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": [],
"action": "complete"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bulk_update_tasks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": [],
"action": "complete"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bulk_delete_tasksBulk delete tasks
Deletes many tasks or activities for good, up to 200 ids per call.
Body
idsarray of stringrequiredTask ids, at most 200
confirmbooleanrequiredTrue once the person has confirmed the delete
curl -X POST "https://api.crossingedge.com/v1/actions/bulk_delete_tasks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": [],
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bulk_delete_tasks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": [],
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bulk_delete_tasks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": [],
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/link_recordsLink records
Links two records: a contact to a company, a contact or company to a deal (with an optional role), a parent company (from) to a subsidiary (to), or any two records a workspace relationship joins (pass relationship when several do).
Body
fromobjectrequiredtoobjectrequiredrolestringA contact’s or company’s role on a deal, e.g. Decision maker
relationshipstringWhich workspace relationship, by label or id, when several join the two
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/link_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"from": {},
"to": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/link_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"from": {},
"to": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/link_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"from": {},
"to": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/unlink_recordsUnlink records
Removes a link between two records (the records themselves stay).
Body
fromobjectrequiredtoobjectrequiredrelationshipstringWhich workspace relationship, by label or id, when several join the two
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/unlink_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"from": {},
"to": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/unlink_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"from": {},
"to": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/unlink_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"from": {},
"to": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_deal_from_pipelineRemove deal from pipeline
Takes a deal out of one of the pipelines it runs in, keeping it in the others, as Remove from pipeline on the deal does: its time there stops, and the pipeline left leading decides its stage.
Body
idnumberrequiredDeal id
pipelinestringrequiredThe pipeline to leave: its name or id
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/remove_deal_from_pipeline" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": 101,
"pipeline": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_deal_from_pipeline", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": 101,
"pipeline": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_deal_from_pipeline",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": 101,
"pipeline": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Workspace settings
Actions/actions/get_settingsGet settings
How the workspace is set up: pipelines and their stages (and stageFields: what each stage needs filled in before a record enters it), objects, custom fields per object, the choices of standard fields (contact status, source, buying roles, company ICP), relationships, workspace settings (currency, fiscal year, business hours, stage time targets, file limits: maxFileMb and storageMb), members and AI.
Body
sectionstringOne of pipelines objects fields choices relationships workspace members ai
curl -X POST "https://api.crossingedge.com/v1/actions/get_settings" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"section": "pipelines"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_settings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"section": "pipelines"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_settings",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"section": "pipelines"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_pipelineCreate pipeline
Adds a deal pipeline with its stages.
Body
namestringrequiredPipeline name
descriptionstringWhat it is for
stagesarray of objectrequiredThe full list of stages, in order: { name, kind: open|won|lost, probability 0-100, color: gray|blue|green|yellow|orange|red|purple, targetHours (how long a deal should sit there) }. Keep a stage’s id (from get_settings) to rename it; a stage left out is removed (refused while open deals sit in it). The last two are always the one won stage and the one lost stage.
makeDefaultbooleanMake it the pipeline new deals land in
splitCreditbooleanLet several people share credit on its deals (see set_deal_split)
curl -X POST "https://api.crossingedge.com/v1/actions/create_pipeline" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"stages": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_pipeline", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"stages": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_pipeline",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"stages": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_pipelineUpdate pipeline
Renames a pipeline or changes its open stages.
Body
pipelinestringrequiredPipeline name or id
namestringNew name
descriptionstringNew description
stagesarray of objectThe full list of stages, in order: { name, kind: open|won|lost, probability 0-100, color: gray|blue|green|yellow|orange|red|purple, targetHours (how long a deal should sit there) }. Keep a stage’s id (from get_settings) to rename it; a stage left out is removed (refused while open deals sit in it). The last two are always the one won stage and the one lost stage.
splitCreditbooleanLet several people share credit on its deals. Off keeps existing splits; they stop counting until it is on again
curl -X POST "https://api.crossingedge.com/v1/actions/update_pipeline" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"pipeline": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_pipeline", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"pipeline": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_pipeline",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"pipeline": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_default_pipelineSet default pipeline
Makes a pipeline the one new deals land in.
Body
pipelinestringrequiredPipeline name or id
curl -X POST "https://api.crossingedge.com/v1/actions/set_default_pipeline" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"pipeline": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_default_pipeline", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"pipeline": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_default_pipeline",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"pipeline": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_pipelineArchive pipeline
Archives a pipeline (its deals and history stay; it can be restored) or restores one with archived: false.
Body
pipelinestringrequiredPipeline name or id
archivedbooleanfalse to restore; default true
curl -X POST "https://api.crossingedge.com/v1/actions/archive_pipeline" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"pipeline": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_pipeline", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"pipeline": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_pipeline",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"pipeline": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_warehousesList warehouses
The warehouses stock sits in: name, code, city, state, which one is the default, and which are archived.
curl -X POST "https://api.crossingedge.com/v1/actions/list_warehouses" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_warehouses", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_warehouses",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_warehouseCreate warehouse
Adds a warehouse.
Body
namestringrequiredIts name, unique in the workspace
codestringA short code, optional
citystringOptional
statestringOptional
curl -X POST "https://api.crossingedge.com/v1/actions/create_warehouse" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_warehouse", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_warehouse",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_warehouseUpdate warehouse
Renames or edits a warehouse (by name, code or id), and makeDefault: true makes it the default.
Body
warehousestringrequiredWarehouse name, code or id
namestringNew name
codestringNew code
citystringCity
statestringState
makeDefaultbooleantrue to make it the default
curl -X POST "https://api.crossingedge.com/v1/actions/update_warehouse" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"warehouse": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_warehouse", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"warehouse": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_warehouse",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"warehouse": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_warehouseArchive warehouse
Archives a warehouse (its stock and history stay; it is no longer offered for new stock) or restores one with archived: false.
Body
warehousestringrequiredWarehouse name, code or id
archivedbooleanfalse to restore; default true
curl -X POST "https://api.crossingedge.com/v1/actions/archive_warehouse" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"warehouse": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_warehouse", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"warehouse": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_warehouse",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"warehouse": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_objectCreate object
Adds an object of the workspace’s own (like Projects or Tickets), with a required Name field to start.
Body
namestringrequiredSingular, e.g. Project
pluralstringrequiredPlural, e.g. Projects
iconstringOne of box folder ticket calendar chart tag star flag
colorstringgray, blue, green, yellow, orange, red, purple
curl -X POST "https://api.crossingedge.com/v1/actions/create_object" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"plural": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_object", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"plural": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_object",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"plural": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_objectUpdate object
Renames a workspace object or changes its icon, colour, or which fields name and describe its records.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
namestringSingular
pluralstringPlural
iconstringOne of box folder ticket calendar chart tag star flag
colorstringgray, blue, green, yellow, orange, red, purple
titleFieldstringField (label or id) that names a record
subtitleFieldstringField (label or id) shown under the name
curl -X POST "https://api.crossingedge.com/v1/actions/update_object" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_object", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_object",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_objectArchive object
Archives a workspace object (hidden, records kept, can be restored) or restores it with archived: false.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
archivedbooleanfalse to restore; default true
curl -X POST "https://api.crossingedge.com/v1/actions/archive_object" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_object", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_object",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_objectDelete object
Deletes a workspace object for good, with its fields and views.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_object" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_object", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_object",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_fieldCreate field
Adds a custom field to any object, built in or the workspace’s own.
Body
objectstringrequiredcontacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural
labelstringrequiredField name, e.g. Contract value
typestringOne of text longText number currency percent date datetime checkbox singleSelect multiSelect email phone url country user file
optionsarray of stringChoices, for singleSelect and multiSelect
helpstringA line of help under the field
requiredbooleanEvery record must have it
uniquebooleanNo two records may share a value (text, email, phone, url, number, currency, date)
defaultValueanyWhat new records start with
magicstringMakes it a magic field, filled from these plain-language instructions on every record and kept up to date as its inputs change: maths ({Amount} * {Seats}), rules, roll-ups over linked records (SUM({Deals › Amount})), a linked record’s value (FIRST({Companies › Industry})), or an AI judgment or short piece of writing from the record’s fields. Name fields in braces. Types: text, longText, number, currency, percent, date, datetime, checkbox, singleSelect, multiSelect. Try it first with preview_magic_field. Not on members: use formula there.
visibilitystringMember fields only, who can see it: self (admins and the member, the default), admins (admins only), everyone (anyone who can see the member list)
One of self admins everyone
formulastringMember fields only: makes it a formula over other member fields, by label in braces, e.g. "{Base salary} + {Variable pay}" or "{Variable pay} / {Base salary} * 100". Worked left to right. Its type is worked out
filesobjectcurl -X POST "https://api.crossingedge.com/v1/actions/create_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"label": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"label": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"label": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_fieldUpdate field
Changes a custom field’s label, help, required, unique or default.
Body
objectstringrequiredcontacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural
fieldstringrequiredField label or id
labelstringNew label
helpstringHelp line
requiredbooleanRequired
uniquebooleanUnique
defaultValueanyDefault for new records
optionsarray of stringFull list of choices (only adding; use set_field_choices to rename or remove)
magicstringA magic field’s new instructions; every record not set by hand is worked out again
visibilitystringMember fields only, who can see it: self (admins and the member, the default), admins (admins only), everyone (anyone who can see the member list)
One of self admins everyone
formulastringMember formula fields only: the new formula, as in create_field
curl -X POST "https://api.crossingedge.com/v1/actions/update_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/preview_magic_fieldTry magic instructions
Try a magic field’s instructions before saving: what they are understood as (a formula, an AI judgment or AI writing, and the fields read), the answer on up to five real records, and what running it on every record would cost.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
typestringrequiredOne of text longText number currency percent date datetime checkbox singleSelect multiSelect
instructionsstringrequiredPlain-language instructions; name fields in braces, like {Amount}
optionsarray of stringChoices, for singleSelect and multiSelect
labelstringThe field’s name
recordIdsarray of numberUp to five records to try it on (default: the latest)
curl -X POST "https://api.crossingedge.com/v1/actions/preview_magic_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"type": "text",
"instructions": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/preview_magic_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"type": "text",
"instructions": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/preview_magic_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"type": "text",
"instructions": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_magic_runsGet magic runs
What a magic field did: with a record, that record’s recent runs (when, why, before and after, confidence) and whether its value was set by hand; without, the field’s run log this month with totals, filtered to errors, unsure or set by hand.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredField label or id
recordIdnumberOne record
filterstringOne of errors unsure manual changed
curl -X POST "https://api.crossingedge.com/v1/actions/get_magic_runs" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_magic_runs", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_magic_runs",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/refresh_magic_fieldRefresh magic field
Works a magic field out again: on one record now (returns the new value), or on every record not set by hand, in the background.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredField label or id
recordIdnumberOne record; leave out for all
curl -X POST "https://api.crossingedge.com/v1/actions/refresh_magic_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/refresh_magic_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/refresh_magic_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/release_magic_valueLet magic fill again
“Let magic fill this again”: a magic field someone set by hand on one record goes back to being filled by magic, worked out now.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredField label or id
recordIdnumberrequiredThe record
curl -X POST "https://api.crossingedge.com/v1/actions/release_magic_value" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…",
"recordId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/release_magic_value", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…",
"recordId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/release_magic_value",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…",
"recordId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/pause_magic_fieldPause magic field
Pauses a magic field (nothing runs; values stay) or resumes it (every record not set by hand catches up).
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredField label or id
pausedbooleanrequiredtrue to pause, false to resume
curl -X POST "https://api.crossingedge.com/v1/actions/pause_magic_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…",
"paused": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/pause_magic_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…",
"paused": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/pause_magic_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…",
"paused": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_field_choicesSet field choices
Sets the choices of a select field: a custom single or multi select, or a standard one (contacts: status, source, buyingRoles; companies: icp).
Body
objectstringrequiredcontacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural
fieldstringrequiredField label or id, or status / source / buyingRoles / icp
choicesarray of objectrequiredThe full list, in order: strings, or { value, color (gray, blue, green, yellow, orange, red, purple) }
replacementsobjectWhere records on an old choice go: { "Old": "New" or null }
defaultValuestringStandard fields: the choice new records start with
curl -X POST "https://api.crossingedge.com/v1/actions/set_field_choices" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…",
"choices": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_field_choices", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…",
"choices": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_field_choices",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…",
"choices": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_fieldArchive field
Archives a custom field (hidden, values kept, can be restored) or restores it with archived: false.
Body
objectstringrequiredcontacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural
fieldstringrequiredField label or id
archivedbooleanfalse to restore; default true
forcebooleanArchive even though agents use it
curl -X POST "https://api.crossingedge.com/v1/actions/archive_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/arrange_fieldsArrange fields
Shapes an object’s fields for everyone in the workspace: the order they appear in (record pages, forms, tables), standard fields to hide or show again, and standard fields to make required or optional.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
orderarray of stringFields in the order they should appear, first first
hidearray of stringStandard fields to hide
showarray of stringHidden standard fields to show again
requirearray of stringStandard fields to make required
optionalarray of stringStandard fields to make optional again
curl -X POST "https://api.crossingedge.com/v1/actions/arrange_fields" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/arrange_fields", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/arrange_fields",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_fieldDelete field
Deletes an archived custom field and every value it holds, permanently.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredCustom field label or id
confirmbooleantrue only after the person has agreed to erase it for good
curl -X POST "https://api.crossingedge.com/v1/actions/delete_field" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_field", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_field",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_relationshipCreate relationship
Joins two objects so their records can be linked, e.g.
Body
fromstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
tostringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fromLabelstringrequiredWhat a from record calls its linked to records, e.g. Projects
toLabelstringrequiredWhat a to record calls its linked from records, e.g. Account
manyTobooleanA from record may hold several to records (default true)
manyFrombooleanA to record may be held by several from records (default true)
curl -X POST "https://api.crossingedge.com/v1/actions/create_relationship" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"from": "…",
"to": "…",
"fromLabel": "…",
"toLabel": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_relationship", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"from": "…",
"to": "…",
"fromLabel": "…",
"toLabel": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_relationship",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"from": "…",
"to": "…",
"fromLabel": "…",
"toLabel": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_relationshipUpdate relationship
Renames a relationship’s labels or changes whether each side may hold several records.
Body
relationshipstringrequiredRelationship id or either label
fromLabelstringNew from label
toLabelstringNew to label
manyTobooleanmanyTo
manyFrombooleanmanyFrom
showReversebooleanShow it on the to side too
curl -X POST "https://api.crossingedge.com/v1/actions/update_relationship" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"relationship": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_relationship", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"relationship": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_relationship",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"relationship": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_relationshipArchive relationship
Archives a relationship (hidden, links kept, can be restored) or restores it with archived: false.
Body
relationshipstringrequiredRelationship id or either label
archivedbooleanfalse to restore; default true
curl -X POST "https://api.crossingedge.com/v1/actions/archive_relationship" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"relationship": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_relationship", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"relationship": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_relationship",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"relationship": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_relationshipDelete relationship
Deletes a relationship for good.
Body
relationshipstringrequiredRelationship id or either label
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_relationship" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"relationship": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_relationship", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"relationship": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_relationship",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"relationship": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_workspace_settingsUpdate workspace settings
Changes workspace-wide settings: its name, currency (USD, EUR, GBP, INR, …), fiscal year start month, business hours for stage clocks, stage time targets for contact statuses ({ "contacts.status.Working": 48 } hours; 0 removes), which statuses make the funnel, which select field a record’s stage clock follows, and the file limits: the largest file anyone may upload (maxFileMb, 1 to 25 MB, default 5) and all the workspace’s files together (storageMb, 100 to 5120 MB, default 1024).
Body
namestringWorkspace name
currencystringISO currency code
fiscalYearStartnumberMonth the fiscal year starts, 1-12
businessHoursobject{ mode: 'calendar' | 'business', days: [1..5] (0 is Sunday), startMinute: 540, endMinute: 1080, timezone: 'Asia/Kolkata' }
targetsobjectHours allowed per stage, keyed object.field.value
funnelarray of stringContact statuses in funnel order
tracksobjectWhich select field each object’s stage clock follows, e.g. { contacts: "status" }
maxFileMbnumberThe largest file anyone may upload, in MB: 1 to 25
storageMbnumberAll the workspace’s files together, in MB: 100 to 5120 (5 GB)
priceBookFromCompanybooleanA new deal takes its company’s price book. Off: every deal starts on the default book
missingPricestringA product with no price in the deal’s book: default uses the default book’s price, empty skips it so the product’s own price is used, else the line is left to fill in
One of default empty
curl -X POST "https://api.crossingedge.com/v1/actions/update_workspace_settings" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"currency": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_workspace_settings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"currency": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_workspace_settings",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"currency": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_stage_fieldsSet stage fields
Sets the fields a record must have filled in before it can enter a stage, for any object with stages: deals (per pipeline), contacts (their status) or the workspace’s own objects (their stage field).
Body
objectstringrequireddeals, contacts, or one of the workspace’s own objects (its id)
pipelinestringDeals only: the pipeline’s name or id. Left out: the default pipeline.
stagestringrequiredThe stage’s name (or a deal stage’s id)
fieldsarray of stringrequiredThe fields this stage needs, by label or key. Empty clears it.
alsoEarlierbooleanAlso need every earlier stage’s fields. Left out: unchanged (yes by default, no for a lost stage).
curl -X POST "https://api.crossingedge.com/v1/actions/set_stage_fields" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"stage": "…",
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_stage_fields", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"stage": "…",
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_stage_fields",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"stage": "…",
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_company_aboutGet About the company
Reads About the company: the workspace’s own text on what it sells, who buys it and why they pick it, which every AI part (drafts, judgements, agents, the assistant) reads as context.
curl -X POST "https://api.crossingedge.com/v1/actions/get_company_about" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_company_about", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_company_about",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_company_aboutUpdate About the company
Saves About the company as written: plain text, at most about 1,000 words (6,000 characters), with what they sell, who buys it, why they pick them, and any rules on their own line.
Body
textstringrequiredThe whole text, as it should read
curl -X POST "https://api.crossingedge.com/v1/actions/update_company_about" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"text": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_company_about", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"text": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_company_about",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"text": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/draft_company_aboutDraft About the company
Drafts About the company from the workspace’s website (its home page and a few of its own pages) and the onboarding answer, in the background: it lands in a minute or two, marked to check.
Body
websitestringThe website to read, like acme.com. Left out: the one saved
replacebooleanReplace text someone wrote; only after they said yes
curl -X POST "https://api.crossingedge.com/v1/actions/draft_company_about" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"website": "…",
"replace": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/draft_company_about", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"website": "…",
"replace": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/draft_company_about",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"website": "…",
"replace": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/add_memberAdd member
Invites someone to the workspace by email (or phone): they are added straight away and emailed an invite with a Join button (notify: false to add them quietly).
Body
emailstringrequiredTheir email or phone
namestringTheir name
rolestringOne of member admin
profilestringA profile by name or id (members only)
notifybooleanEmail them an invite (default true)
curl -X POST "https://api.crossingedge.com/v1/actions/add_member" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"email": "priya@acme.com"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/add_member", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"email": "priya@acme.com"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/add_member",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"email": "priya@acme.com"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/resend_inviteResend invite
Emails someone who was added but hasn’t signed in yet their invite again.
Body
memberstringrequiredMember email or name
curl -X POST "https://api.crossingedge.com/v1/actions/resend_invite" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/resend_invite", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/resend_invite",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_memberUpdate member
Changes a member: role (member or admin; owners and admins can always do everything) or the profile a member is on (see list_profiles), which then says everything they can do.
Body
memberstringrequiredMember email or name
rolestringOne of member admin
profilestringA profile by name or id
curl -X POST "https://api.crossingedge.com/v1/actions/update_member" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_member", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_member",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_membersList members
The team as an object: every member you may see with their built-in fields (name, email, phone, role, joined, signed in) and the workspace’s own member fields (pay, team, targets and the like) by label, formulas worked out.
curl -X POST "https://api.crossingedge.com/v1/actions/list_members" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_members", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_members",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_memberGet member
One member: their built-in fields, their own fields you may see (by label), and the history of changes to those fields, newest first.
Body
memberstringrequiredMember email, name or user id
curl -X POST "https://api.crossingedge.com/v1/actions/get_member" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"member": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_member", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"member": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_member",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"member": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_member_detailsSet member details
Sets a member’s own fields, such as base salary, variable pay or team: values by field label (or id); null clears one.
Body
memberstringrequiredMember email, name or user id
valuesobjectrequiredField label or id → value, e.g. { "Base salary": 1200000, "Team": "North" }
curl -X POST "https://api.crossingedge.com/v1/actions/set_member_details" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"values": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_member_details", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"values": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_member_details",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"values": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_memberRemove member
Removes someone from the workspace; the records they own stay.
Body
memberstringrequiredMember email or name
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/remove_member" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_member", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_member",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_ai_settingsUpdate AI settings
Switches AI duplicate detection on or off (switching on can also check existing contacts and companies from a date, YYYY-MM-DD, or all of them), switches AI magic fields on or off, and sets their monthly AI budget in dollars.
Body
duplicatesbooleanDetect duplicates
backfillSincestring'all' or YYYY-MM-DD: check existing records too
magicbooleanAI magic fields may run
magicBudgetnumberMonthly AI budget for magic fields, in dollars
intentbooleanAI reads records for High intent
winMeansstringWhat counts as a win, in plain words; "" for a won deal
webSearchbooleanThe chat may search the web when someone switches it on
curl -X POST "https://api.crossingedge.com/v1/actions/update_ai_settings" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"duplicates": true,
"backfillSince": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_ai_settings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"duplicates": true,
"backfillSince": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_ai_settings",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"duplicates": True,
"backfillSince": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_choice_usageGet choice usage
How many records hold each choice of a standard dropdown (a contact’s status or source, a company’s ICP fit, a deal’s buying roles and the like), as editing its choices in Settings shows, before renaming or removing one.
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldstringrequiredThe dropdown’s field key, e.g. status or source
curl -X POST "https://api.crossingedge.com/v1/actions/get_choice_usage" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"field": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_choice_usage", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"field": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_choice_usage",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"field": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/load_sample_dataLoad sample data
Fills an empty workspace with sample companies, contacts, deals and tasks to try things on, as Load sample data in onboarding does.
curl -X POST "https://api.crossingedge.com/v1/actions/load_sample_data" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/load_sample_data", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/load_sample_data",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_sample_dataRemove sample data
Takes the sample data out of the workspace, as Remove sample data does: every sample record nobody has changed or worked on since it was loaded (those are kept, as someone’s own now).
Body
confirmbooleanrequiredTrue once the person has said remove it
curl -X POST "https://api.crossingedge.com/v1/actions/remove_sample_data" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_sample_data", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_sample_data",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Insights and history
Actions/actions/find_duplicatesFind duplicates
Finds duplicate contacts or companies.
Body
objectstringrequiredcontacts or companies
One of contacts companies
idnumberOne record to check
limitnumberHow many pairs, default 30, at most 200
curl -X POST "https://api.crossingedge.com/v1/actions/find_duplicates" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "contacts"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/find_duplicates", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "contacts"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/find_duplicates",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "contacts"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/scan_duplicatesScan for duplicates
Runs the AI duplicate check over existing contacts and companies (all of them, or those created since a date), in the background.
Body
sincestring'all' (default) or YYYY-MM-DD
curl -X POST "https://api.crossingedge.com/v1/actions/scan_duplicates" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"since": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/scan_duplicates", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"since": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/scan_duplicates",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"since": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/dismiss_duplicateDismiss duplicate
Marks two records as not duplicates, so the pair stops being suggested.
Body
objectstringrequiredcontacts or companies
One of contacts companies
anumberrequiredOne record id
bnumberrequiredThe other record id
curl -X POST "https://api.crossingedge.com/v1/actions/dismiss_duplicate" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "contacts",
"a": 101,
"b": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/dismiss_duplicate", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "contacts",
"a": 101,
"b": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/dismiss_duplicate",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "contacts",
"a": 101,
"b": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/merge_previewMerge preview
Shows what merging two contacts or companies would do before doing it: which values the kept record keeps or takes from the duplicate (with the choices per field), and the deals, activities, notes, links and history that move over.
Body
objectstringrequiredcontacts or companies
One of contacts companies
keepnumberrequiredId of the record that stays
removenumberrequiredId of the duplicate folded into it and then deleted
curl -X POST "https://api.crossingedge.com/v1/actions/merge_preview" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "contacts",
"keep": 101,
"remove": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/merge_preview", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "contacts",
"keep": 101,
"remove": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/merge_preview",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "contacts",
"keep": 101,
"remove": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/merge_recordsMerge records
Merges a duplicate contact or company into the one that stays: its deals, activities, notes, links, people and history move over, chosen field values are copied, and the duplicate is deleted.
Body
objectstringrequiredcontacts or companies
One of contacts companies
keepnumberrequiredId of the record that stays
removenumberrequiredId of the duplicate
choicesobjectPer field, from merge_preview: "existing" keeps the kept record’s value, "incoming" takes the duplicate’s, "both" keeps both companies
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/merge_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "contacts",
"keep": 101,
"remove": 101,
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/merge_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "contacts",
"keep": 101,
"remove": 101,
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/merge_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "contacts",
"keep": 101,
"remove": 101,
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/start_deep_analysisStart a deep analysis
Reads every record of an object (deals by default) against one question, in the background: its fields and what was said on it (notes, calls and meetings, emails), then writes one report into Insights and emails the person.
Body
questionstringrequiredWhat the analysis should answer, in the person’s words
objectstringWhich object: deals (default), contacts, companies or a workspace object
confirmbooleantrue once the person agreed to the cost
curl -X POST "https://api.crossingedge.com/v1/actions/start_deep_analysis" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"question": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/start_deep_analysis", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"question": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/start_deep_analysis",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"question": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_deep_analysisDeep analysis
How far a deep analysis has got (records read of the total, cost so far), and its report link once written.
Body
idstringrequiredThe analysis id start_deep_analysis gave
stopbooleanStop it now
curl -X POST "https://api.crossingedge.com/v1/actions/get_deep_analysis" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_deep_analysis", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_deep_analysis",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/explain_recordExplain a record
How a record came to be and what has happened to it, as evidence: who or what made it (a person, an agent and the exact run that did it, an import, a webhook, the assistant) and when; for an agent, what set that run off (the change on which record, and who made it); its recent history with the source of each change; the agent runs it set off; and, for a deal, other deals for the same people or companies made within a week (likely duplicates), each with how it was made; for a contact, its deals and how each was made.
Body
objectstringrequiredAny object
idnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/explain_record" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/explain_record", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/explain_record",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_historyGet history
A record’s change history, newest first: who or what created, changed (field by field, from and to), linked, merged or deleted things, and when.
Body
objectstringrequiredAny object
idnumberrequiredRecord id
limitnumberHow many, default 20, at most 100
beforestringThe cursor from the previous page
curl -X POST "https://api.crossingedge.com/v1/actions/get_history" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_history", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_history",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_high_intentGet high intent
High intent, as the app shows it: the contacts, companies and deals the AI reads as most likely to turn into business soon, most likely first, each with its fit, intent and urgency (0 to 1) and the reasons it gave.
Body
objectstringcontacts, companies or deals; leave out for all three
limitnumberHow many of each, most likely first (default 20, at most 100)
curl -X POST "https://api.crossingedge.com/v1/actions/get_high_intent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"limit": 20
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_high_intent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"limit": 20
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_high_intent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"limit": 20
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_high_intent_againRead high intent again
Has the AI read every contact, company and deal again for High intent, as Read all again in Settings does: they are queued and read in the background within the workspace’s AI budget (each costs AI credits), so new readings arrive over the next minutes.
curl -X POST "https://api.crossingedge.com/v1/actions/read_high_intent_again" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_high_intent_again", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_high_intent_again",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/learn_high_intentLearn high intent
Has High intent learn now, as Learn now in Settings does, instead of waiting for its weekly run: from the workspace’s past wins (won deals, or what update_ai_settings winMeans says counts as a win) it finds which questions about a record predicted them, and uses that order only when it beats the AI’s plain reading.
curl -X POST "https://api.crossingedge.com/v1/actions/learn_high_intent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/learn_high_intent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/learn_high_intent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_stage_timesGet stage times
How long a record has spent in each stage (deal pipeline stages, or a contact’s status), counting business hours when the workspace uses them: where it is now, for how long, against the target, every stage it passed through, and its journey: each stay in order with when it came in, when it left and how long it stayed.
Body
objectstringrequiredAny object with a stage: deals, contacts, …
idnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/get_stage_times" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"id": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_stage_times", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"id": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_stage_times",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"id": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_overdueList overdue
Records that have sat in their stage past its target (overdue) or are close to it (due soon), longest over first.
Body
objectstringOnly this object (deals, contacts, …)
includestringDefault overdue
One of overdue dueSoon both
limitnumberHow many, default 30
curl -X POST "https://api.crossingedge.com/v1/actions/list_overdue" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"include": "overdue"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_overdue", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"include": "overdue"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_overdue",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"include": "overdue"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_insightsGet insights
The Insights page as data: leads and conversion, won value, win rate, time to win, the funnel, segments, execution, what needs attention, and observations, for a period against the one before.
Body
periodstringDefault month
One of day week month quarter year custom
yearnumberYear
quarternumber1-4
fromstringcustom: first day, YYYY-MM-DD
tostringcustom: last day, YYYY-MM-DD
pipelinestringPipeline name or id
filtersarray of objectDeal filters: [{ key, values? | text? | min?, max? }]
curl -X POST "https://api.crossingedge.com/v1/actions/get_insights" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"period": "day",
"year": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_insights", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"period": "day",
"year": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_insights",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"period": "day",
"year": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_spendGet spend
Marketing spend by source and month, as entered for Insights.
curl -X POST "https://api.crossingedge.com/v1/actions/get_spend" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_spend", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_spend",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_spendSet spend
Records what was spent on a lead source in a month (amount 0 means nothing was spent; null clears it back to unknown).
Body
sourcestringrequiredLead source, as in contact sources
monthstringrequiredYYYY-MM
amountnumberrequiredAmount in the workspace currency, or null for unknown
curl -X POST "https://api.crossingedge.com/v1/actions/set_spend" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"source": "…",
"month": "…",
"amount": 12000
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_spend", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"source": "…",
"month": "…",
"amount": 12000
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_spend",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"source": "…",
"month": "…",
"amount": 12000
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_viewsList views
Saved views: yours and the shared ones, each with everything needed to recreate it (filters, sort, hidden columns, column order and the columns it shows; any board settings it keeps: mode, groupBy, the deals board’s pipeline; for Insights and report views their period and pipeline), who made it, and which one opens by default for you.
Body
objectstringThe list: contacts, companies, deals, products, a workspace object, tasks, insights, or report
reportstringFor object report: the report’s name or id
curl -X POST "https://api.crossingedge.com/v1/actions/list_views" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals",
"report": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_views", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals",
"report": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_views",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals",
"report": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_card_fieldsSet card fields
Sets what each card shows on a board, for the person this token belongs to (their own choice, not part of any view).
Body
objectstringrequiredObject whose board this is
fieldsarray of stringField keys shown on each card, in order, at most 10
curl -X POST "https://api.crossingedge.com/v1/actions/set_card_fields" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_card_fields", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_card_fields",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/save_viewSave view
Saves a view of a list, or changes one (pass view: its name or id), the way the app's Views menu does.
Body
objectstringThe list: contacts, companies, deals, products, a workspace object, tasks, insights, or report
reportstringFor object report: the report’s name or id
viewstringAn existing view’s name or id, to change it
namestringView name
filtersarray of objectsortobject{ id: column, dir: asc | desc }, or null for the list’s own sort
columnsarray of stringEvery column to show, in order; the rest are hidden
hiddenarray of stringColumns to hide (replaces the hidden set)
showarray of stringColumns to show on top of what shows now
orderarray of stringColumns to put first, in this order
periodobject | stringInsights and report views: { kind: week | month | quarter | year | custom, year?, quarter?, from?, to? }
pipelinestringInsights and report views: a pipeline’s name or id, "default", or "all". Deals views: the pipeline the board shows (name, id or "default"); null to leave it to each person
modestringlist or board: how the list opens with this view; null (or left out) leaves it to each person
groupBystringTasks views: how the board groups, dueBucket (Due), status, priority or assignee; null leaves it to each person
sharedbooleanShare with the workspace
makeDefaultbooleanOpen this view by default for you
curl -X POST "https://api.crossingedge.com/v1/actions/save_view" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"report": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/save_view", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"report": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/save_view",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"report": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_default_viewSet default view
Which view a list opens on for you: a saved view by name or id, one of the list’s built-in views (contacts: all, mine, unassigned, leads, unassigned-leads; companies: all, mine, unassigned; deals: all, mine, open, unassigned; products: all, mine; tasks: all, open, overdue, following, done; others: all), or null for the page default.
Body
objectstringThe list: contacts, companies, deals, products, a workspace object, tasks, insights, or report
reportstringFor object report: the report’s name or id
viewstringrequiredView name or id, a built-in id, or null
curl -X POST "https://api.crossingedge.com/v1/actions/set_default_view" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"view": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_default_view", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"view": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_default_view",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"view": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_viewDelete view
Deletes a saved view (the records it lists are untouched).
Body
viewstringrequiredView name or id
objectstringIts list, when names repeat across lists
reportstringFor object report: the report’s name or id
curl -X POST "https://api.crossingedge.com/v1/actions/delete_view" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"view": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_view", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"view": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_view",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"view": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_reportDelete report
Deletes a report for good (its author, or an owner or admin).
Body
reportstringrequiredReport id or name
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"report": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"report": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"report": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_email_conversationsList email conversations
Email conversations brought in by Gmail sync or logged by hand: subject, people, how many emails, the newest one, its AI brief and whether it needs a reply.
Body
minebooleanOnly conversations from the person’s own inboxes
qstringSearch subject, people and text
recordobjectOnly the ones on this record
curl -X POST "https://api.crossingedge.com/v1/actions/list_email_conversations" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"mine": true,
"q": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_email_conversations", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"mine": true,
"q": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_email_conversations",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"mine": True,
"q": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_email_conversationRead email conversation
One email conversation, oldest first: each email’s sender, recipients and own text (quoted history cut), the brief, the records it is on, and whether the person can reply from Crossing Edge (from which of their inboxes, and who Reply and Reply all go to).
Body
keystringrequiredConversation key from list_email_conversations
curl -X POST "https://api.crossingedge.com/v1/actions/read_email_conversation" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"key": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_email_conversation", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"key": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_email_conversation",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"key": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/draft_email_replyDraft email reply
Drafts the person’s reply to an email conversation in their own writing style (learned from the email they send), with their signature on the end.
Body
keystringrequiredConversation key
allbooleanReply all rather than reply
changestringTo refine a draft: what to change, in the person’s words ("shorter", "mention the Friday deadline")
draftstringTo refine: the draft as it stands now, with any edits they made
curl -X POST "https://api.crossingedge.com/v1/actions/draft_email_reply" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"key": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/draft_email_reply", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"key": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/draft_email_reply",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"key": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/send_email_replySend email reply
Sends a reply to an email conversation through the person’s own Gmail, threaded under it, and keeps it in the conversation.
Body
keystringrequiredConversation key, from list_email_conversations or a reply task’s replyTo.conversation
textstringrequiredThe message, plain text
allbooleanReply all: everyone else on the thread too
toarray of stringEmail addresses to send to (replaces the default)
ccarray of stringCc addresses (replaces the default)
bccarray of stringBcc addresses
subjectstringSubject (default Re: the conversation’s)
inboxstringWhich of the person’s inboxes to send from (default the one it came through)
confirmbooleanrequiredTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/send_email_reply" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"key": "…",
"text": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/send_email_reply", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"key": "…",
"text": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/send_email_reply",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"key": "…",
"text": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_writing_profileGet writing profile
How the person writes their email, as Crossing Edge learned it from what they send (tone, length, greeting, sign-off, phrases, what they avoid), and the emails they pasted in to learn from.
curl -X POST "https://api.crossingedge.com/v1/actions/get_writing_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_writing_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_writing_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/relearn_writing_profileLearn writing style again
Learns the person’s writing profile again now, from their latest sent email and pasted samples.
curl -X POST "https://api.crossingedge.com/v1/actions/relearn_writing_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/relearn_writing_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/relearn_writing_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/add_writing_sampleAdd writing sample
Teaches the person’s writing profile from an email they wrote, pasted whole (up to 5 kept).
Body
textstringrequiredAn email the person wrote, whole
curl -X POST "https://api.crossingedge.com/v1/actions/add_writing_sample" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"text": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/add_writing_sample", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"text": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/add_writing_sample",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"text": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_email_signatureSet email signature
The signature added to the end of the person’s drafted replies: text to use word for word (line breaks kept; "" for no signature), or null to go back to the one found at the end of their emails.
Body
textstringrequiredThe signature, or "" for none, or null for the one in their email
curl -X POST "https://api.crossingedge.com/v1/actions/set_email_signature" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"text": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_email_signature", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"text": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_email_signature",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"text": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_writing_sampleRemove writing sample
Removes one of the emails the person pasted into their writing profile, by its index from get_writing_profile.
Body
indexnumberrequiredIndex from get_writing_profile
curl -X POST "https://api.crossingedge.com/v1/actions/remove_writing_sample" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"index": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_writing_sample", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"index": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_writing_sample",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"index": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/forget_writing_profileForget writing profile
Forgets what was learned about how the person writes, and the emails they pasted.
Body
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/forget_writing_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/forget_writing_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/forget_writing_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Gmail sync
Actions/actions/get_gmailGet Gmail
The person’s own connected Gmail inboxes: address, how each is connected (Sign in with Google or an app password), status, last check, problems, how much was brought in, and how many emails wait in each Review.
curl -X POST "https://api.crossingedge.com/v1/actions/get_gmail" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_gmail", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_gmail",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_gmail_brought_inList emails brought in
Emails Gmail sync brought into the CRM from one of the person’s inboxes: when, which way, why, and the records each was logged on.
Body
inboxstringInbox address or id (optional when there is one)
daysnumberHow many days back (default 7)
curl -X POST "https://api.crossingedge.com/v1/actions/list_gmail_brought_in" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"inbox": "…",
"days": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_gmail_brought_in", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"inbox": "…",
"days": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_gmail_brought_in",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"inbox": "…",
"days": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_gmail_statusPause or resume Gmail
Pauses or resumes Gmail sync for one of the person’s inboxes.
Body
inboxstringInbox address or id (optional when there is one)
statusstringrequiredOne of paused active
curl -X POST "https://api.crossingedge.com/v1/actions/set_gmail_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "paused"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_gmail_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"status": "paused"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_gmail_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"status": "paused"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/check_gmail_nowCheck Gmail now
Reads new mail in one of the person’s inboxes now, rather than waiting for the next minute.
Body
inboxstringInbox address or id (optional when there is one)
curl -X POST "https://api.crossingedge.com/v1/actions/check_gmail_now" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"inbox": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/check_gmail_now", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"inbox": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/check_gmail_now",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"inbox": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_gmailDisconnect Gmail
Disconnects one of the person’s own inboxes; emails already brought in stay.
Body
inboxstringInbox address or id (optional when there is one)
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_gmail" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_gmail", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_gmail",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_team_inboxesList team inboxes
Owners and admins: every member’s connected Gmail inbox (address, status, last check).
curl -X POST "https://api.crossingedge.com/v1/actions/list_team_inboxes" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_team_inboxes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_team_inboxes",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_team_inboxDisconnect a member’s inbox
Owners and admins: disconnects a member’s Gmail inbox, by its id from list_team_inboxes.
Body
idstringrequiredInbox id
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_team_inbox" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_team_inbox", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_team_inbox",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_email_reviewList emails to review
Emails waiting in the person’s own Review page (the ones Crossing Edge was unsure about: maybe not sales, maybe private, many people): who, subject, snippet and why.
Body
inboxstringInbox address or id (optional: all of theirs)
hoursnumberOnly emails from the last this many hours (optional)
curl -X POST "https://api.crossingedge.com/v1/actions/list_email_review" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"inbox": "…",
"hours": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_email_review", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"inbox": "…",
"hours": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_email_review",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"inbox": "…",
"hours": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_review_emailRead email to review
One email waiting in the person’s Review, in full, by its id from list_email_review.
Body
idstringrequiredEmail id
curl -X POST "https://api.crossingedge.com/v1/actions/read_review_email" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_review_email", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_review_email",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bring_in_review_emailsBring emails into the CRM
Brings emails from the person’s Review into the CRM: logged on the people (and their companies) outside the team, creating contacts where needed.
Body
idsarray of stringrequiredEmail ids
curl -X POST "https://api.crossingedge.com/v1/actions/bring_in_review_emails" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bring_in_review_emails", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bring_in_review_emails",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_skipped_emailsList skipped emails
Emails Gmail sync left out of the CRM in the person’s own inboxes over the last 14 days, newest first: who sent it, the subject, the date and why in plain words (Gmail Promotions tab, Marketing newsletter, Automated sender, Mailing list, Notification, Not a sales email, Your own team, Draft, Private).
Body
inboxstringInbox address or id (optional: all of theirs)
reasonstringOnly this reason, in its words (optional)
hoursnumberOnly emails from the last this many hours (optional)
curl -X POST "https://api.crossingedge.com/v1/actions/list_skipped_emails" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"inbox": "…",
"reason": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_skipped_emails", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"inbox": "…",
"reason": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_skipped_emails",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"inbox": "…",
"reason": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_inbox_emailsList inbox emails
Every email that came into the person’s own inboxes in the last hours (default 24, at most 14 days), wherever it landed: Brought in (in the CRM), Review (waiting for them) or Skipped (newsletters, notifications, not sales, private), newest first, one list across all their inboxes: id, where it landed, inbox, who sent it, subject, date and why it was skipped.
Body
hoursnumberHow many hours back (default 24, at most 336)
landedstringOnly the ones that landed there (optional)
One of Brought in Review Skipped
curl -X POST "https://api.crossingedge.com/v1/actions/list_inbox_emails" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"hours": 101,
"landed": "Brought in"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_inbox_emails", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"hours": 101,
"landed": "Brought in"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_inbox_emails",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"hours": 101,
"landed": "Brought in"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_inbox_emailRead inbox email
One email from the person’s own inboxes in full, by its id from list_inbox_emails, wherever it landed: who sent it (fromName, fromEmail), who it went to, the subject and its text.
Body
idstringrequiredEmail id
curl -X POST "https://api.crossingedge.com/v1/actions/read_inbox_email" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_inbox_email", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_inbox_email",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_skipped_emailRead skipped email
One skipped email in full, read again from the person’s own Gmail by its id from list_skipped_emails: who sent it, who it went to, the subject and its text.
Body
idstringrequiredEmail id
curl -X POST "https://api.crossingedge.com/v1/actions/read_skipped_email" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_skipped_email", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_skipped_email",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/bring_in_skipped_emailsBring skipped emails into the CRM
Brings skipped emails into the CRM after all: each is read again from the person’s Gmail and logged on the people (and their companies) outside the team, creating contacts where needed.
Body
idsarray of stringrequiredEmail ids
curl -X POST "https://api.crossingedge.com/v1/actions/bring_in_skipped_emails" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/bring_in_skipped_emails", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/bring_in_skipped_emails",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/dismiss_review_emailsDismiss emails
Dismisses emails from the person’s Review: they never come into the CRM and their copy is deleted.
Body
idsarray of stringrequiredEmail ids
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/dismiss_review_emails" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": [],
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/dismiss_review_emails", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": [],
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/dismiss_review_emails",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": [],
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Telegram
Actions/actions/get_telegramGet Telegram
The person’s Telegram in Crossing Edge: the workspace bot, whether their account is linked (and the link to do it), their Business chatbot and personal account, their filters, the groups the bot is in, and how many chats are tracked or waiting.
curl -X POST "https://api.crossingedge.com/v1/actions/get_telegram" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_telegram", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_telegram",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_telegram_filtersSet Telegram filters
The person’s own Telegram filters.
Body
onlySalesChatsbooleanOnly sales chats come in
holdPrivateMessagesbooleanPrivate-looking messages wait for you
curl -X POST "https://api.crossingedge.com/v1/actions/set_telegram_filters" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"onlySalesChats": true,
"holdPrivateMessages": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_telegram_filters", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"onlySalesChats": true,
"holdPrivateMessages": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_telegram_filters",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"onlySalesChats": True,
"holdPrivateMessages": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_telegram_chatsList Telegram chats
Telegram chats brought into Crossing Edge (1:1 Business chats, groups with the workspace bot, personal account chats): people, last message, AI brief, linked records.
Body
minebooleanOnly the person’s own chats
qstringSearch
kindstringOne of private group
reviewbooleanTheir chats waiting for them to track or ignore
ignoredbooleanChats they ignored
recordobjectOnly the ones on this record
curl -X POST "https://api.crossingedge.com/v1/actions/list_telegram_chats" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"mine": true,
"q": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_telegram_chats", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"mine": true,
"q": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_telegram_chats",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"mine": True,
"q": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_telegram_chatRead Telegram chat
One Telegram chat with its messages, oldest first, and whether the person can reply to it from Crossing Edge (as themselves in a Business chat, or through the workspace bot in a group).
Body
idstringrequiredChat id, from list_telegram_chats or a Telegram reply task’s replyTo.conversation
curl -X POST "https://api.crossingedge.com/v1/actions/read_telegram_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_telegram_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_telegram_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/reply_telegram_chatReply on Telegram
Replies in one of the person’s own Telegram chats: as them in a Business chat, through the workspace bot (with their name) in a group.
Body
idstringrequiredChat id
textstringrequiredThe message
confirmbooleanrequiredTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/reply_telegram_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"text": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/reply_telegram_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"text": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/reply_telegram_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"text": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_telegram_chat_statusTrack or ignore a Telegram chat
Tracks one of the person’s Telegram chats (its messages come into the CRM) or ignores it (nothing more comes in; it can be tracked again).
Body
idstringrequiredChat id
statusstringrequiredOne of tracked ignored
curl -X POST "https://api.crossingedge.com/v1/actions/set_telegram_chat_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"status": "tracked"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_telegram_chat_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"status": "tracked"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_telegram_chat_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"status": "tracked"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/link_telegram_chatLink Telegram chat
Links one of the person’s Telegram chats to a record, so its messages show there: an existing contact, company, deal or workspace record (object + recordId), or a new contact made for someone in the chat (newContact).
Body
idstringrequiredChat id
objectstringcontacts, companies, deals, products, or a workspace object id
recordIdnumberRecord id
newContactobjectMake a contact and link it. person: who in the chat (their name, @username or tgUserId; optional in a 1:1 chat)
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/link_telegram_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/link_telegram_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/link_telegram_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/unlink_telegram_chatUnlink Telegram chat
Takes a record off one of the person’s Telegram chats; its messages stop showing there.
Body
idstringrequiredChat id
objectstringrequiredRecord object
recordIdnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/unlink_telegram_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"object": "deals",
"recordId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/unlink_telegram_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"object": "deals",
"recordId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/unlink_telegram_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"object": "deals",
"recordId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/settle_held_telegram_messageBring in or dismiss a held message
A message held back as private in one of the person’s chats: bring: true brings it into the CRM, false dismisses it for good.
Body
idstringrequiredChat id
messageIdnumberrequiredMessage id
bringbooleanrequiredTrue to bring it in, false to dismiss it
curl -X POST "https://api.crossingedge.com/v1/actions/settle_held_telegram_message" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"messageId": 101,
"bring": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/settle_held_telegram_message", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"messageId": 101,
"bring": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/settle_held_telegram_message",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"messageId": 101,
"bring": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_telegram_connectionsList Telegram connections
Owners and admins: who in the workspace has connected Telegram (linked account, Business chatbot, personal account, groups) and which filters they turned off.
curl -X POST "https://api.crossingedge.com/v1/actions/list_telegram_connections" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_telegram_connections", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_telegram_connections",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_member_telegramDisconnect a member’s Telegram
Owners and admins: disconnects a member’s Telegram (their linked account and personal account) from this workspace, someone who left say, as Disconnect in Settings › Telegram does.
Body
memberstringrequiredThe member, by email or name
confirmbooleanrequiredTrue once the person has said disconnect them
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_member_telegram" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_member_telegram", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_member_telegram",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_telegram_account_statusPause or resume my Telegram account
Pauses or resumes the person’s own personal Telegram account in Crossing Edge, as Pause and Resume in Settings › Telegram do.
Body
statusstringrequiredOne of paused active
curl -X POST "https://api.crossingedge.com/v1/actions/set_telegram_account_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "paused"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_telegram_account_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"status": "paused"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_telegram_account_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"status": "paused"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_telegram_botDisconnect the Telegram bot
Owners and admins: disconnects the workspace’s Telegram bot, as Settings › Telegram does.
Body
confirmbooleanrequiredTrue once the person has said disconnect it
curl -X POST "https://api.crossingedge.com/v1/actions/remove_telegram_bot" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_telegram_bot", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_telegram_bot",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/clear_telegram_keysRemove the Telegram app keys
Owners and admins: removes the workspace’s Telegram app keys (my.telegram.org), as Settings › Telegram does.
Body
confirmbooleanrequiredTrue once the person has said remove them
curl -X POST "https://api.crossingedge.com/v1/actions/clear_telegram_keys" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/clear_telegram_keys", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/clear_telegram_keys",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/link_my_telegramLink my Telegram
Makes the link that connects the person’s own Telegram account to the workspace bot, as Link Telegram in Settings › Telegram does: they open it in Telegram and press Start.
curl -X POST "https://api.crossingedge.com/v1/actions/link_my_telegram" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/link_my_telegram", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/link_my_telegram",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_my_telegramDisconnect my Telegram
Disconnects the person’s own Telegram, as Settings › Telegram does: part linked unlinks their account from the workspace bot (Business chats stop), part personal signs Crossing Edge out of their personal account.
Body
partstringrequiredlinked: the bot link; personal: the personal account
One of linked personal
confirmbooleanrequiredTrue once the person has said disconnect it
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_my_telegram" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"part": "linked",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_my_telegram", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"part": "linked",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_my_telegram",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"part": "linked",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Calendar
Actions/actions/get_calendar_statusGet calendar status
The person’s own Google Calendars, one per Google inbox: on, off or needing sign-in again, whether it is syncing, when it was last checked, and whether they may book meetings here.
curl -X POST "https://api.crossingedge.com/v1/actions/get_calendar_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_calendar_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_calendar_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/find_meeting_timeFind meeting time
Finds free times for the person and chosen teammates from their synced calendars, within the workspace’s business hours: the next few free slots, everyone’s busy times (times only, never what), and who clashes with a proposed time.
Body
minutesnumberHow long the meeting is (default 30)
membersarray of numberTeammates, by user id from list_members
fromstringLook from (ISO time; default now)
tostringLook until (ISO time; default 7 days on)
startstringA proposed start, to check for clashes
endstringA proposed end
time_zonestringThe zone to suggest times in
curl -X POST "https://api.crossingedge.com/v1/actions/find_meeting_time" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"minutes": 101,
"members": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/find_meeting_time", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"minutes": 101,
"members": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/find_meeting_time",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"minutes": 101,
"members": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/book_meetingBook meeting
Books a meeting on the person’s own Google Calendar, as New meeting on the Calendar page does: Google emails the invites from their own address (send_invites false puts it only on their calendar), with a Meet link by default.
Body
titlestringrequiredWhat the meeting is called
startstringrequiredWhen it starts: an ISO time with its offset (2026-11-04T10:00:00+05:30), or a date (YYYY-MM-DD) for all day
endstringWhen it ends (or the day after the last day, for all day); default start plus minutes
minutesnumberHow long, when no end is given (default 30)
all_daybooleanA whole-day event
time_zonestringThe IANA zone the times are meant in (repeats follow it); default the person’s own
guestsarray of stringGuest email addresses: contacts (find them with search_contacts) or anyone
membersarray of numberTeammates to invite, by user id from list_members
meetbooleanAdd a Google Meet link (default true)
locationstringWhere
agendastringThe agenda or description guests see
recordsarray of objectRecords it goes on besides its guests’ contacts: the deal, company or contacts it is about
repeatstringRepeats (default never)
One of never daily weekly weekdays monthly
repeat_daysarray of numberFor weekly: the days, 0 is Sunday
reminder_minutesnumberA reminder this many minutes before; null for Google’s default
privatebooleanPrivate on the calendar: others see only Busy
show_asstringShown as busy (default) or free
One of busy free
send_invitesbooleanGoogle emails the guests (default true)
inboxstringWhich Google inbox’s calendar (mailboxId from get_calendar_status)
confirmbooleanTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/book_meeting" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"title": "Call Priya about the renewal",
"start": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/book_meeting", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"title": "Call Priya about the renewal",
"start": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/book_meeting",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"title": "Call Priya about the renewal",
"start": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_meetingUpdate meeting
Reschedules or edits a meeting the person organised on a Google Calendar connected here (title, time, guests, Meet link, place, agenda, reminder, private, busy or free, records), as Reschedule and Edit on the meeting do.
Body
idstringrequiredMeeting id, from list_meetings
titlestringWhat the meeting is called
startstringWhen it starts: an ISO time with its offset (2026-11-04T10:00:00+05:30), or a date (YYYY-MM-DD) for all day
endstringWhen it ends (or the day after the last day, for all day); default start plus minutes
minutesnumberHow long, when no end is given (default 30)
all_daybooleanA whole-day event
time_zonestringThe IANA zone the times are meant in (repeats follow it); default the person’s own
guestsarray of stringGuest email addresses: contacts (find them with search_contacts) or anyone
membersarray of numberTeammates to invite, by user id from list_members
meetbooleanAdd a Google Meet link (default true)
locationstringWhere
agendastringThe agenda or description guests see
recordsarray of objectRecords it goes on besides its guests’ contacts: the deal, company or contacts it is about
repeatstringRepeats (default never)
One of never daily weekly weekdays monthly
repeat_daysarray of numberFor weekly: the days, 0 is Sunday
reminder_minutesnumberA reminder this many minutes before; null for Google’s default
privatebooleanPrivate on the calendar: others see only Busy
show_asstringShown as busy (default) or free
One of busy free
notifybooleanGoogle emails the guests the change (default true)
confirmbooleanTrue once the person has seen the change and said send
curl -X POST "https://api.crossingedge.com/v1/actions/update_meeting" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_meeting", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_meeting",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/cancel_meetingCancel meeting
Cancels a meeting the person organised, off their Google Calendar, as Cancel on the meeting does; Google tells the guests unless notify is false.
Body
idstringrequiredMeeting id, from list_meetings
notifybooleanGoogle emails the guests (default true)
confirmbooleanrequiredTrue once the person has said cancel it
curl -X POST "https://api.crossingedge.com/v1/actions/cancel_meeting" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/cancel_meeting", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/cancel_meeting",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/answer_meetingAnswer meeting
Answers someone else’s invite on the person’s own Google Calendar: going, maybe or not going, as the buttons on the meeting do.
Body
idstringrequiredMeeting id, from list_meetings
answerstringrequiredOne of going maybe not_going
confirmbooleanTrue once the person said send the answer
curl -X POST "https://api.crossingedge.com/v1/actions/answer_meeting" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"answer": "going"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/answer_meeting", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"answer": "going"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/answer_meeting",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"answer": "going"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Webhooks
Actions/actions/list_webhooksList webhooks
The workspace’s incoming webhooks: addresses forms and tools post leads to.
curl -X POST "https://api.crossingedge.com/v1/actions/list_webhooks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_webhooks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_webhooks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_webhook_logGet webhook log
One webhook’s recent posts, newest first: what each lead said, and whether it made a new contact, updated one, waited, or failed and why.
Body
webhookstringWebhook name or id (optional when there is one)
limitnumberHow many (default 20)
curl -X POST "https://api.crossingedge.com/v1/actions/get_webhook_log" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"webhook": "…",
"limit": 20
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_webhook_log", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"webhook": "…",
"limit": 20
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_webhook_log",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"webhook": "…",
"limit": 20
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_webhook_statusPause or resume a webhook
Pauses a webhook (leads wait in its log) or turns it back on (the waiting ones go in).
Body
webhookstringWebhook name or id
statusstringrequiredOne of paused active
curl -X POST "https://api.crossingedge.com/v1/actions/set_webhook_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "paused"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_webhook_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"status": "paused"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_webhook_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"status": "paused"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_webhookCreate webhook
Makes a new webhook: an address a form or tool posts leads to.
Body
namestringrequiredWhere the leads come from, like “Website form”. New contacts get it as their source.
curl -X POST "https://api.crossingedge.com/v1/actions/create_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/map_webhookMap and turn on a webhook
Maps a webhook’s fields (from the tests it has received) onto contact and company fields, sets values every lead gets, and turns it on; on a live one it saves the change.
Body
webhookstringrequiredWebhook name or id
fieldsobjectPayload field (as list_webhooks shows it, e.g. "lead.email") → "contacts:email", "Contact · Email", "skip", or "new:Budget" for a new contact field. Unlisted fields are matched by AI.
valuesarray of objectValues every lead gets. Defaults to the source set to the webhook’s name.
onExistingstringA contact already in the CRM (same email or phone): fill its blanks (default), overwrite, or leave it
One of fill overwrite skip
companyFromDomainbooleanFind or add the company from a work email (default true; free mail never makes one)
namestringA new name for it
curl -X POST "https://api.crossingedge.com/v1/actions/map_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/map_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/map_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/preview_webhookPreview a webhook lead
What a webhook’s latest post would become, written nowhere: the fields it would set, the contact it would update (same email or phone), the company its email finds or makes, and the agents it would start (name and why).
Body
webhookstringWebhook name or id
curl -X POST "https://api.crossingedge.com/v1/actions/preview_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"webhook": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/preview_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"webhook": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/preview_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"webhook": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/run_webhook_post_againRun a webhook post again
Runs one post from a webhook’s log again (one that failed, waited while paused, or was a test), by its id from get_webhook_log.
Body
webhookstringWebhook name or id
poststringrequiredPost id from get_webhook_log
curl -X POST "https://api.crossingedge.com/v1/actions/run_webhook_post_again" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"post": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/run_webhook_post_again", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"post": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/run_webhook_post_again",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"post": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/new_webhook_addressNew webhook address
Gives a webhook a new address; the old one stops working at once, so the tool must be given the new one.
Body
webhookstringWebhook name or id
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/new_webhook_address" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/new_webhook_address", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/new_webhook_address",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_webhookDelete webhook
Deletes a webhook: its address stops working and its log goes.
Body
webhookstringrequiredWebhook name or id
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Outgoing webhooks
Actions/actions/list_webhook_eventsList webhook events
Every event a sending (outgoing) webhook can send out of the workspace, with what each means: records created, changed, deleted; deals moving stage, won, lost; tasks, notes, emails, Telegram messages, meetings, imports.
curl -X POST "https://api.crossingedge.com/v1/actions/list_webhook_events" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_webhook_events", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_webhook_events",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_outgoing_webhooksList sending webhooks
The workspace’s sending webhooks: addresses that get its events (Zapier, Make, n8n, Slack, their own systems).
curl -X POST "https://api.crossingedge.com/v1/actions/list_outgoing_webhooks" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_outgoing_webhooks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_outgoing_webhooks",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_outgoing_webhookMake sending webhook
Makes a sending webhook: from now on the chosen events go to the address as signed JSON POSTs, retried for about a day if it fails.
Body
namestringrequiredWhat it is for, e.g. "Won deals to Slack"
urlstringrequiredThe https address to send to
eventsarray of stringrequiredEvents to send (list_webhook_events)
objectsarray of stringOnly these kinds of record (contacts, companies, deals, products, or a workspace object’s id or name from get_schema); leave out for every kind
conditionsobjectOptional, per record type: only send events about records that match, e.g. {"deals":[{"key":"amount","min":"100000"}]}. Each filter: key (a field key from get_schema), and values (choices), text (contains), min/max (numbers, dates YYYY-MM-DD) or empty (true/false). Events about tasks, emails, messages, notes and imports are not filtered.
confirmbooleanTrue once the person has seen it and said yes
curl -X POST "https://api.crossingedge.com/v1/actions/create_outgoing_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"url": "…",
"events": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_outgoing_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"url": "…",
"events": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_outgoing_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"url": "…",
"events": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_outgoing_webhookChange sending webhook
Changes a sending webhook’s name, address, events or conditions.
Body
webhookstringrequiredSending webhook name or id
namestringNew name
urlstringNew https address
eventsarray of stringEvents to send (list_webhook_events)
objectsarray of stringOnly these kinds of record (contacts, companies, deals, products, or a workspace object’s id or name from get_schema); leave out for every kind
conditionsobjectOptional, per record type: only send events about records that match, e.g. {"deals":[{"key":"amount","min":"100000"}]}. Each filter: key (a field key from get_schema), and values (choices), text (contains), min/max (numbers, dates YYYY-MM-DD) or empty (true/false). Events about tasks, emails, messages, notes and imports are not filtered.
curl -X POST "https://api.crossingedge.com/v1/actions/update_outgoing_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_outgoing_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_outgoing_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_outgoing_webhook_statusPause or resume sending webhook
Pauses a sending webhook (nothing is sent or saved up while paused) or turns it back on (it sends what happens from then on; whoever turns it on becomes its maker).
Body
webhookstringSending webhook name or id
statusstringrequiredOne of paused active
curl -X POST "https://api.crossingedge.com/v1/actions/set_outgoing_webhook_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "paused"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_outgoing_webhook_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"status": "paused"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_outgoing_webhook_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"status": "paused"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/test_outgoing_webhookTest sending webhook
Sends a sample of one event to a sending webhook’s address now (marked test: true, made-up values) and says what came back: status, reply and time taken.
Body
webhookstringSending webhook name or id
eventstringWhich event to send a sample of (default its first)
One of record.created record.updated record.deleted record.merged record.owner_changed record.linked record.unlinked deal.stage_changed deal.won deal.lost contact.status_changed task.created task.completed activity.logged note.added email.received email.sent telegram.received telegram.sent meeting.booked meeting.summary_ready import.finished
curl -X POST "https://api.crossingedge.com/v1/actions/test_outgoing_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…",
"event": "record.created"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/test_outgoing_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…",
"event": "record.created"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/test_outgoing_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…",
"event": "record.created"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_outgoing_webhook_logGet sending webhook log
A sending webhook’s recent sends, newest first: event, when, whether it got through, the reply, tries so far and the next try.
Body
webhookstringSending webhook name or id (optional when there is one)
curl -X POST "https://api.crossingedge.com/v1/actions/get_outgoing_webhook_log" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"webhook": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_outgoing_webhook_log", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"webhook": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_outgoing_webhook_log",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"webhook": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/resend_webhook_deliverySend again
Sends one logged send again within the minute, its tries counted from zero (get_outgoing_webhook_log for its id).
Body
deliverystringrequiredThe send’s id from the log
curl -X POST "https://api.crossingedge.com/v1/actions/resend_webhook_delivery" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"delivery": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/resend_webhook_delivery", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"delivery": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/resend_webhook_delivery",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"delivery": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/new_outgoing_webhook_secretNew signing secret
Makes a new signing secret for a sending webhook.
Body
webhookstringrequiredSending webhook name or id
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/new_outgoing_webhook_secret" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/new_outgoing_webhook_secret", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/new_outgoing_webhook_secret",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_outgoing_webhookDelete sending webhook
Deletes a sending webhook and its log; nothing more is sent to its address.
Body
webhookstringrequiredSending webhook name or id
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_outgoing_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"webhook": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_outgoing_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"webhook": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_outgoing_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"webhook": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}IndiaMART
Actions/actions/get_indiamartGet IndiaMART
How IndiaMART is connected: status, the key (last 4 only), the webhook address, what each enquiry becomes (mapping, values every lead gets, deal, call task), who gets each lead, and counts.
curl -X POST "https://api.crossingedge.com/v1/actions/get_indiamart" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_indiamart", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_indiamart",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_indiamart_enquiriesList IndiaMART enquiries
The latest IndiaMART enquiries and what each became: a new lead, updated, already in the CRM, failed (with why) or waiting.
Body
limitnumberHow many (default 20, up to 200)
resultstringOnly this result
One of created updated skipped failed held
curl -X POST "https://api.crossingedge.com/v1/actions/list_indiamart_enquiries" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"limit": 20,
"result": "created"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_indiamart_enquiries", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 20,
"result": "created"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_indiamart_enquiries",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"limit": 20,
"result": "created"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/connect_indiamartConnect IndiaMART
Connects IndiaMART, or replaces its CRM key.
Body
keystringThe CRM key, when the person gave one
curl -X POST "https://api.crossingedge.com/v1/actions/connect_indiamart" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"key": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/connect_indiamart", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"key": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/connect_indiamart",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"key": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_indiamartUpdate IndiaMART
Changes what IndiaMART enquiries become and who gets them, and switches a new connection on.
Body
mapobjectIndiaMART field → target
everyLeadGetsarray of objectValues every lead gets
ownersobjectWho gets each lead
dealobject{ on, pipelineId, stage }
callTaskobject{ on, dueMinutes }
existingRecordsstringOne of fill overwrite skip
agentsbooleanRun agents on each lead
pastDaysnumber7, 30, 90 or 365
curl -X POST "https://api.crossingedge.com/v1/actions/update_indiamart" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"map": {},
"everyLeadGets": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_indiamart", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"map": {},
"everyLeadGets": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_indiamart",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"map": {},
"everyLeadGets": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_indiamart_statusPause or resume IndiaMART
Pauses IndiaMART (enquiries sent by webhook are held and come in on resume) or resumes it.
Body
statusstringrequiredOne of paused active
curl -X POST "https://api.crossingedge.com/v1/actions/set_indiamart_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "paused"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_indiamart_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"status": "paused"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_indiamart_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"status": "paused"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/check_indiamart_nowCheck IndiaMART now
Asks IndiaMART for new enquiries now.
curl -X POST "https://api.crossingedge.com/v1/actions/check_indiamart_now" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/check_indiamart_now", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/check_indiamart_now",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/retry_indiamart_enquiryRetry IndiaMART enquiry
Takes a failed or waiting IndiaMART enquiry again, by its id from list_indiamart_enquiries.
Body
idstringrequiredEnquiry id
curl -X POST "https://api.crossingedge.com/v1/actions/retry_indiamart_enquiry" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/retry_indiamart_enquiry", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/retry_indiamart_enquiry",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/new_indiamart_webhookNew IndiaMART webhook address
Makes a new webhook address for IndiaMART; the old one stops working at once, so the new one must be pasted into IndiaMART’s Push API page.
Body
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/new_indiamart_webhook" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/new_indiamart_webhook", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/new_indiamart_webhook",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_indiamartDisconnect IndiaMART
Disconnects IndiaMART: the key, mapping, owners and enquiry log go; leads already made stay.
Body
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_indiamart" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_indiamart", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_indiamart",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Events
Actions/actions/list_eventsList events
The workspace’s events in event mode (conferences, trade fairs), running ones first: their lead source, how many people were captured at each by you and in total, and the link to the capture page.
curl -X POST "https://api.crossingedge.com/v1/actions/list_events" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_events", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_events",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_eventGet event
One event and everyone captured at it: who, who captured them, how (QR, card photo or typed) and when, newest first.
Body
eventstringrequiredEvent name or id
curl -X POST "https://api.crossingedge.com/v1/actions/get_event" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_event", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"event": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_event",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"event": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_eventCreate event
Starts an event in event mode and returns its capture-page link (open it on a phone to scan QR codes and cards).
Body
namestringrequiredEvent name, e.g. TOKEN2049
sourcestringLead source captures start on
addSourcebooleanAdd source as a new lead source choice first
curl -X POST "https://api.crossingedge.com/v1/actions/create_event" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_event", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_event",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/end_eventEnd event
Ends an event so its link stops capturing, or reopens it with reopen: true.
Body
eventstringrequiredEvent name or id
reopenbooleanReopen an ended event
curl -X POST "https://api.crossingedge.com/v1/actions/end_event" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"event": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/end_event", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"event": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/end_event",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"event": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/capture_at_eventCapture at event
Adds someone met at an event: either an existing contact (contactId), or a new lead from their details, owned by you and on the event’s source.
Body
eventstringrequiredEvent name or id
contactIdnumberAn existing contact, instead of new details
firstNamestringFirst name
lastNamestringLast name
emailstringphonestringPhone
jobTitlestringJob title
companyIdnumberTheir company, if already in the CRM
telegramstringTelegram handle, without the @
xstringX (Twitter) handle, without the @
linkedinstringLinkedIn profile URL
notestringAnything else worth keeping, added to the note
methodstringHow they were captured; default typed
One of qr photo typed
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/capture_at_event" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"event": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/capture_at_event", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"event": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/capture_at_event",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"event": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Exports
Actions/actions/export_recordsExport records
Exports records as a spreadsheet and returns a download link (kept 7 days).
Body
objectsarray of objectrequiredWhat to export, one entry per object
curl -X POST "https://api.crossingedge.com/v1/actions/export_records" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"objects": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/export_records", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"objects": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/export_records",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"objects": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_exportsList exports
Past exports from the Exports page, newest first: the person’s own, or everyone’s for owners and admins, each with its rows, who made it, and its download link while it lasts (7 days).
curl -X POST "https://api.crossingedge.com/v1/actions/list_exports" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_exports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_exports",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Agents
Actions/actions/list_agentsList agents
The workspace’s agents the caller may see: what each does, what starts it, whether it is on or paused (and why), its last run, its runs and cost this month, what needs attention (something it names that is gone), and failed runs in the last 7 days with the last error.
curl -X POST "https://api.crossingedge.com/v1/actions/list_agents" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_agents", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_agents",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/make_agentMake agent
Makes an agent from the person’s plain words: a job the CRM does on its own when something happens to a record (created, a field changed, no activity for N days, a task overdue, in one stage past its time allowed or longer than N hours or days) or on a schedule.
Body
wordsstringrequiredThe job in the person’s own words, with any answer to an earlier question added
sendModestringOnly when the agent would email or message a customer: "send" to send on its own, "draft" to leave drafts for the person to check. Ask the person once; never choose for them.
savebooleantrue to save the plan once the person has seen it and is happy
planobjectWith save: true, the plan the earlier answer returned, unchanged
curl -X POST "https://api.crossingedge.com/v1/actions/make_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"words": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/make_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"words": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/make_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"words": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/change_agentChange agent
Changes an agent by plain words ("only for leads from India").
Body
agentstringrequiredThe agent’s id or name
changestringrequiredWhat to change, in plain words
sendModestringOnly when the agent would email or message a customer: "send" to send on its own, "draft" to leave drafts for the person to check. Ask the person once; never choose for them.
savebooleantrue to save the changed plan once the person has seen it
planobjectWith save: true, the plan the earlier answer returned, unchanged
curl -X POST "https://api.crossingedge.com/v1/actions/change_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"agent": "…",
"change": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/change_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"agent": "…",
"change": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/change_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"agent": "…",
"change": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/try_agentTry agent
Try it: goes over the newest records of the agent’s kind (20 unless count says otherwise, up to 50) without writing or sending anything.
Body
agentstringrequiredThe agent’s id or name
countnumberHow many recent records to go over, 1 to 50 (default 20)
curl -X POST "https://api.crossingedge.com/v1/actions/try_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"agent": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/try_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"agent": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/try_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"agent": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/pause_agentPause or resume agent
Pauses an agent, or resumes it with paused: false.
Body
agentstringrequiredThe agent’s id or name
pausedbooleantrue to pause (the default), false to resume
curl -X POST "https://api.crossingedge.com/v1/actions/pause_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"agent": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/pause_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"agent": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/pause_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"agent": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_agent_runsAgent runs
An agent’s runs, newest first, a page at a time: when, why, which record, what each step did, the cost.
Body
agentstringrequiredThe agent’s id or name
filterstringOne of errors drafts skipped
beforestringThe next value from the previous page
limitnumberRuns per page, up to 100 (default 20)
curl -X POST "https://api.crossingedge.com/v1/actions/get_agent_runs" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"agent": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_agent_runs", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"agent": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_agent_runs",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"agent": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/ask_agentAsk agent
Asks one agent a question, such as “what did it do today?” or “why is it paused?”.
Body
agentstringrequiredThe agent’s id or name
questionstringrequiredThe question
curl -X POST "https://api.crossingedge.com/v1/actions/ask_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"agent": "…",
"question": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/ask_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"agent": "…",
"question": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/ask_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"agent": "…",
"question": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_agentDelete agent
Deletes an agent and its run log for good.
Body
agentstringrequiredThe agent’s id or name
confirmbooleanMust be true, after the person agreed
curl -X POST "https://api.crossingedge.com/v1/actions/delete_agent" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"agent": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_agent", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"agent": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_agent",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"agent": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Documents
Actions/actions/list_filesList files
Files in Documents, as far as the person can see them.
Body
recordobjectOnly the files on this record
folderstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
tagstringOnly files with this tag
qstringWords that must all be in the file’s name
limitnumberHow many files, default 50, at most 200
curl -X POST "https://api.crossingedge.com/v1/actions/list_files" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"record": {},
"folder": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_files", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"record": {},
"folder": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_files",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"record": {},
"folder": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_fileRead file
Reads a text file (plain text, CSV, JSON, Markdown and the like) the person can see, on a record or in the Library.
Body
idstringrequiredFile id, from list_files
curl -X POST "https://api.crossingedge.com/v1/actions/read_file" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_file", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_file",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/attach_fileAttach file
Adds a file, from a public https link, as base64, or written as text (a plan.md, summary.html, notes.txt, data.csv: text plus a name ending in .md, .html, .txt, .csv or .json, stored with that type), onto a record (its Files tab; onlyMe: true keeps it to the person, owners and admins) or into the Library (a folder, or the root), exactly as uploading it in the app does: the workspace’s largest-file and storage limits apply, and the person needs attach rights on the record, or Library upload rights.
Body
namestringFile name with its extension, e.g. "Quote.pdf". Default: the link’s own name
urlstringA public https link to the file
base64stringThe file itself, base64 encoded (instead of url)
textstringThe file's text, written out (instead of url or base64): markdown, HTML, plain text, CSV or JSON. Needs name, ending in .md, .html, .txt, .csv or .json
typestringIts type, e.g. application/pdf. Default: what the link says, else from the name
recordobjectThe record it goes on
folderstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
onlyMebooleanRecord files only: just the person (and owners and admins) can see it
forNewstringInstead of record or folder: the object (e.g. contacts) of a record about to be made, to upload a file for one of its file fields. Send the id back in that field on create_record; it becomes the new record’s file. Unused, it goes after a day
fieldstringRecord files only: a file field on the record (its label or id) to put the file in as well. A field that holds one file has it replaced
approvalobjectWhen a change needs approval: {"why": "the person’s reason", "answers": {other form questions by key}, "replace": true}. replace takes back a request already waiting on that field and asks with this change instead: only once the person said to.
curl -X POST "https://api.crossingedge.com/v1/actions/attach_file" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"url": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/attach_file", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"url": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/attach_file",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"url": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_fileUpdate file
Changes one file: its name, its tags (the whole list, by name; a new name makes the tag), Only me on a record file, for a Library document its folder and who can see it, or for a text file (.md, .html, .txt, .csv, .json) what is in it (text, the whole new content; read it first with read_file).
Body
idstringrequiredFile id, from list_files
namestringNew name, with its extension
textstringA text file only: its whole new content
tagsarray of stringIts tags from now on, by name
onlyMebooleanRecord files: only the person, owners and admins see it
folderstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
shareanyWho can see it in the Library: "everyone", "folder" (the same as its folder, the default for a new document), or { admins: true|false, people: [emails or names] }
curl -X POST "https://api.crossingedge.com/v1/actions/update_file" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_file", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_file",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_filesUpdate files
One change to many files at once (up to 500), as selecting them in Documents does: move Library documents to a folder, or add or remove tags.
Body
idsarray of stringrequiredFile ids, from list_files
folderstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
addTagsarray of stringTags to add, by name (a new name makes the tag)
removeTagsarray of stringTags to take off, by name
curl -X POST "https://api.crossingedge.com/v1/actions/update_files" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_files", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_files",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_filesRemove files
Deletes files (one or many) to Recently deleted, as deleting them in the app does: they leave every list and can be put back with restore_deleted for 30 days.
Body
idsarray of stringrequiredFile ids, from list_files
curl -X POST "https://api.crossingedge.com/v1/actions/remove_files" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ids": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_files", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"ids": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_files",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ids": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/link_documentLink document to record
Shows a Library document on a record too (one copy, still shared only as the document says), as "Link from Library" on a record does.
Body
idstringrequiredLibrary document id, from list_files
recordobjectrequiredcurl -X POST "https://api.crossingedge.com/v1/actions/link_document" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"record": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/link_document", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"record": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/link_document",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"record": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/unlink_documentUnlink document from record
Takes a Library document off a record.
Body
idstringrequiredLibrary document id
recordobjectrequiredcurl -X POST "https://api.crossingedge.com/v1/actions/unlink_document" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"record": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/unlink_document", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"record": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/unlink_document",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"record": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_folderCreate folder
A new Library folder, at the top or inside another.
Body
namestringrequiredFolder name
parentstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
shareanyWho can see it in the Library: "everyone", "folder" (the same as its folder, the default for a new document), or { admins: true|false, people: [emails or names] }
curl -X POST "https://api.crossingedge.com/v1/actions/create_folder" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_folder", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_folder",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_folderUpdate folder
Renames a Library folder, moves it into another (never inside itself), or changes who can see it ("folder" for the same as its parent).
Body
folderstringrequiredA Library folder: its id (fd_…), its name, or "root" for the top of the Library
namestringNew name
parentstringA Library folder: its id (fd_…), its name, or "root" for the top of the Library
shareanyWho can see it in the Library: "everyone", "folder" (the same as its folder, the default for a new document), or { admins: true|false, people: [emails or names] }
curl -X POST "https://api.crossingedge.com/v1/actions/update_folder" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"folder": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_folder", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"folder": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_folder",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"folder": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_folderDelete folder
Deletes a Library folder to Recently deleted with every folder and document inside it; restore_deleted on the folder brings all of it back for 30 days.
Body
folderstringrequiredA Library folder: its id (fd_…), its name, or "root" for the top of the Library
curl -X POST "https://api.crossingedge.com/v1/actions/delete_folder" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"folder": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_folder", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"folder": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_folder",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"folder": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_tagCreate tag
A new tag for files.
Body
namestringrequiredTag name
colorstringIts colour
One of gray blue green yellow orange red purple
curl -X POST "https://api.crossingedge.com/v1/actions/create_tag" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_tag", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_tag",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_tagUpdate tag
Renames or recolours a tag, everywhere it is used.
Body
tagstringrequiredThe tag, by name or id
namestringNew name
colorstringNew colour
One of gray blue green yellow orange red purple
curl -X POST "https://api.crossingedge.com/v1/actions/update_tag" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tag": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_tag", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"tag": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_tag",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"tag": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_tagDelete tag
Deletes a tag for good and takes it off every file.
Body
tagstringrequiredThe tag, by name or id
confirmbooleanrequiredTrue once the person has said delete it
curl -X POST "https://api.crossingedge.com/v1/actions/delete_tag" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tag": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_tag", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"tag": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_tag",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"tag": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_deleted_filesList deleted files
Recently deleted: files and folders deleted in the last 30 days that the person sees there (what they deleted, or everything for owners, admins and Library managers), newest first, with who deleted each.
curl -X POST "https://api.crossingedge.com/v1/actions/list_deleted_files" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_deleted_files", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_deleted_files",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/restore_deletedRestore deleted
Puts a file or folder from Recently deleted back where it was (a folder with everything deleted with it).
Body
idstringrequiredFile or folder id, from list_deleted_files
curl -X POST "https://api.crossingedge.com/v1/actions/restore_deleted" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/restore_deleted", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/restore_deleted",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Imports
Actions/actions/preview_paste_importPreview paste import
Reads pasted leads or a pasted table the way the app’s paste import does, and says what each column would become, a few rows, and anything that must be decided first.
Body
textstringrequiredWhat was pasted: a table copied from a spreadsheet, CSV text, or leads as messages, emails or a typed list
columnsobjectChange what a column goes to: { "<column>": "<field>" }, the field as preview_paste_import names it (or its key, such as contacts:email), or "skip" to leave the column out
pipelinesobjectFor a pipeline the sheet names that is not one: { "<name in the sheet>": "<an existing pipeline>" | "new" }
linksobjectFor a workspace object with more than one way to link: { "<object>": "<relationship id>" | "none" }
fillobjectA value for a required field, used only on the rows that leave it empty: { "<field>": "<value>" }
pipelinestringWhere deals go when the sheet names no pipeline (default: the default pipeline)
setarray of objectValues every record of an object gets, whatever the sheet says: [{ field, value }], or [{ newDropdown: { object, label }, value }] to make a dropdown with this as its first choice
valueMapobjectWhat a column’s values become: { "<column>": { "<value in the sheet>": "<choice or member>" | null } }; null leaves the field empty. Values not named import as they are
onExistingstringFor a record already here: fill its empty fields (default), overwrite them, or skip the row
One of fill overwrite skip
curl -X POST "https://api.crossingedge.com/v1/actions/preview_paste_import" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/preview_paste_import", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"text": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/preview_paste_import",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"text": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/paste_importPaste import
Imports pasted leads or a pasted table into the CRM through the app’s own import: the same column matching, records made or updated (onExisting), the import listed on the Imports page, undoable for a day with undo_import.
Body
textstringrequiredWhat was pasted: a table copied from a spreadsheet, CSV text, or leads as messages, emails or a typed list
columnsobjectChange what a column goes to: { "<column>": "<field>" }, the field as preview_paste_import names it (or its key, such as contacts:email), or "skip" to leave the column out
pipelinesobjectFor a pipeline the sheet names that is not one: { "<name in the sheet>": "<an existing pipeline>" | "new" }
linksobjectFor a workspace object with more than one way to link: { "<object>": "<relationship id>" | "none" }
fillobjectA value for a required field, used only on the rows that leave it empty: { "<field>": "<value>" }
pipelinestringWhere deals go when the sheet names no pipeline (default: the default pipeline)
setarray of objectValues every record of an object gets, whatever the sheet says: [{ field, value }], or [{ newDropdown: { object, label }, value }] to make a dropdown with this as its first choice
valueMapobjectWhat a column’s values become: { "<column>": { "<value in the sheet>": "<choice or member>" | null } }; null leaves the field empty. Values not named import as they are
onExistingstringFor a record already here: fill its empty fields (default), overwrite them, or skip the row
One of fill overwrite skip
agentsbooleanRun the workspace’s agents on each record it writes (default off, as in the app)
curl -X POST "https://api.crossingedge.com/v1/actions/paste_import" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"text": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/paste_import", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"text": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/paste_import",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"text": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_importsList imports
Imports from the Imports page: the person’s own, or everyone’s for owners and admins, newest first, with what each made and how many rows had problems.
Body
idstringOne import’s id
curl -X POST "https://api.crossingedge.com/v1/actions/list_imports" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_imports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_imports",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/fix_import_rowFix import row
Takes one problem row of an import again, as Fix on the import does: with its cells corrected (by column name) and values for required fields it lacked.
Body
idstringrequiredImport id
rownumberrequiredRow number, as list_imports shows it
cellsobjectCorrected cells: { "<column>": "<value>" }; the rest stay as they were
valuesobjectValues for required fields the row lacks: { "<field>": "<value>" }
curl -X POST "https://api.crossingedge.com/v1/actions/fix_import_row" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"row": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/fix_import_row", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"row": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/fix_import_row",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"row": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/undo_importUndo import
Undoes an import within a day of it finishing, as Undo on the Imports page does: removes the records it made (ones someone else changed since, or the person may not delete, are kept and counted).
Body
idstringrequiredImport id
confirmbooleanrequiredTrue once the person has said undo it
curl -X POST "https://api.crossingedge.com/v1/actions/undo_import" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/undo_import", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/undo_import",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}My preferences
Actions/actions/get_my_preferencesGet my preferences
The person’s own switches, as Settings shows them: their name, reminder emails for their tasks, emails from agents (and which agents they stopped), desktop notifications for each (and the browsers they are on in), and reply tasks (a task opens by itself when a customer waits on their reply, by email, Telegram or after a meeting).
curl -X POST "https://api.crossingedge.com/v1/actions/get_my_preferences" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_my_preferences", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_my_preferences",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_my_preferencesSet my preferences
Changes the person’s own switches, as Settings does: reminderEmails, agentEmails (every agent’s emails to them, on or off), stopAgentEmails or resumeAgentEmails (one agent’s, by name), desktopAlerts and desktopReminders (desktop notifications for each), replyTasks, and their name.
Body
reminderEmailsbooleanEmail me my task reminders
agentEmailsbooleanAgents may email me
stopAgentEmailsstringStop one agent’s emails to me: its name or id
resumeAgentEmailsstringStart one agent’s emails to me again: its name or id
desktopAlertsbooleanShow agent alerts as desktop notifications too
desktopRemindersbooleanShow my task reminders as desktop notifications too
replyTasksbooleanOpen a task when a customer waits on my reply
namestringMy name, as the workspace sees it
curl -X POST "https://api.crossingedge.com/v1/actions/set_my_preferences" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"reminderEmails": true,
"agentEmails": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_my_preferences", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"reminderEmails": true,
"agentEmails": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_my_preferences",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"reminderEmails": True,
"agentEmails": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}API keys and AI tools
Actions/actions/list_mcp_connectionsList connected AI tools
The AI tools (Claude, ChatGPT, Cursor and the like) the person has connected to this workspace over MCP, as Settings › MCP and Claude and ChatGPT list them: each one’s name, whether it signed in or uses a key, and when it was last used.
curl -X POST "https://api.crossingedge.com/v1/actions/list_mcp_connections" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_mcp_connections", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_mcp_connections",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_mcp_connectionDisconnect an AI tool
Disconnects one of the person’s connected AI tools, as Disconnect in Settings › MCP does: it stops reaching the workspace at once.
Body
connectionstringrequiredThe AI tool: its id or name, from list_mcp_connections
confirmbooleanTrue once the person has said disconnect it
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_mcp_connection" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"connection": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_mcp_connection", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"connection": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_mcp_connection",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"connection": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_api_keysList API keys
The workspace’s API keys, as Settings › API lists them (owners and admins see everyone’s, others their own; needs “Make API keys”): name, the start of the key, read only or read and write, status, who made it, expiry, last use and requests today and this week.
curl -X POST "https://api.crossingedge.com/v1/actions/list_api_keys" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_api_keys", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_api_keys",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_api_key_activityGet API key activity
One API key’s last requests (when, which operation, its status and time) and its requests per day for the last 14 days, as Settings › API shows them.
Body
keystringrequiredThe key: its id, name or the start of it, from list_api_keys
curl -X POST "https://api.crossingedge.com/v1/actions/get_api_key_activity" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"key": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_api_key_activity", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"key": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_api_key_activity",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"key": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/revoke_api_keyRevoke an API key
Revokes an API key, as Revoke in Settings › API does: it stops working at once, for good, and whatever uses it stops too.
Body
keystringrequiredThe key: its id, name or the start of it, from list_api_keys
confirmbooleanTrue once the person has said revoke it
curl -X POST "https://api.crossingedge.com/v1/actions/revoke_api_key" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"key": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/revoke_api_key", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"key": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/revoke_api_key",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"key": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Quotas and targets
Actions/actions/get_target_typesGet target types
The workspace’s target types: Revenue won (built in) and the ones it made, like Meetings booked or Leads qualified, each with the rule saying what it counts.
curl -X POST "https://api.crossingedge.com/v1/actions/get_target_types" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_target_types", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_target_types",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_target_typeSet target type
Makes a target type, or changes one (by its name or id in type).
Body
typestringTo change one: its name or id. Leave out to make a new one
namestringIts name, like Meetings booked
ruleobjectWhat the target counts. object: deals, contacts, companies, activities or a custom object id. measure: "count" (default) or "sum" with sumField (a number or money field). when: "created", "date" with dateField (a date field), or "changed" with changeField and changeTo (a field changing to a value, like status to Qualified; contacts, companies or deals). credit: a person field key (ownerId, createdBy, completedBy...) or "actor" (whoever made the change, for "changed"). filters: up to 5 { key, values } on the record as it is now, e.g. [{ key: "type", values: ["meeting"] }]. Field keys come from get_schema.
curl -X POST "https://api.crossingedge.com/v1/actions/set_target_type" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"type": "…",
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_target_type", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"type": "…",
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_target_type",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"type": "…",
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/archive_target_typeArchive target type
Archives a target type (or brings one back with restore: true).
Body
typestringrequiredIts name or id
restorebooleanTrue to bring it back
curl -X POST "https://api.crossingedge.com/v1/actions/archive_target_type" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"type": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/archive_target_type", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"type": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/archive_target_type",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"type": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_quotasGet quotas
Every member’s quota: what counts (won in any pipeline, or a chosen pipeline and stage), their quota periods (a month, quarter or year, an amount, from and to months as YYYY-MM) and ramps (the share of quota, or the quota itself, for each month of a new start), plus whether imported deals count.
Body
typestringTarget type, by name or id (see get_target_types). Default: Revenue won
curl -X POST "https://api.crossingedge.com/v1/actions/get_quotas" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_quotas", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"type": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_quotas",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"type": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_quotaSet quota
Sets one member’s quota.
Body
memberstringrequiredMember email, name or user id
typestringTarget type, by name or id (see get_target_types). Default: Revenue won
countsanyWhat counts toward the quota: { pipelineId, stageId } (any stage of that pipeline that is not lost, by id or name; a deal counts once it reaches that stage or a later one), or "won, any pipeline"
periodsarray of objectrequiredAll the member’s quota periods
rampsarray of objectAll the member’s ramps (leave out for none)
curl -X POST "https://api.crossingedge.com/v1/actions/set_quota" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"periods": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_quota", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"periods": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_quota",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"periods": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_quota_progressGet quota progress
The Quotas and Targets page’s numbers for a month, quarter or year: quota, won, what is likely, the gap, who is on track, and the deals that could close it.
Body
viewstringmonth (default), quarter or year
atstringA month inside the period, YYYY-MM (default: this month)
typestringTarget type, by name or id (see get_target_types). Default: Revenue won
peoplearray of string | integerOnly these members, by name, email or id: the numbers are then added up for them alone, as when picking people at the top of the page. Left out, everyone the person may see. Ignored for someone who sees only their own.
curl -X POST "https://api.crossingedge.com/v1/actions/get_quota_progress" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"view": "…",
"at": "2026-11-02T10:00:00Z"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_quota_progress", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"view": "…",
"at": "2026-11-02T10:00:00Z"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_quota_progress",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"view": "…",
"at": "2026-11-02T10:00:00Z"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Slack
Actions/actions/get_slackGet Slack
Whether Slack is connected for this workspace, which Slack workspace it is, the channels the Slack bot is in (private and shared ones marked), and every member with the Slack person they match.
curl -X POST "https://api.crossingedge.com/v1/actions/get_slack" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_slack", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_slack",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/match_slack_memberMatch a Slack member
Says which Slack person a member is, when their emails differ.
Body
memberstringrequiredThe member: name, email or id
slackUserIdstringTheir Slack user id, like U01ABCDE
slackEmailstringTheir email address in Slack
nonebooleanTrue when this member has no Slack account
autobooleanTrue to go back to matching by email
curl -X POST "https://api.crossingedge.com/v1/actions/match_slack_member" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/match_slack_member", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/match_slack_member",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/disconnect_slackDisconnect Slack
Disconnects Slack from this workspace: the app is taken out of Slack, and every agent step and start that uses Slack stops until it is added again (the agents say so on their cards).
Body
confirmbooleanrequiredTrue once the person has confirmed
curl -X POST "https://api.crossingedge.com/v1/actions/disconnect_slack" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/disconnect_slack", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/disconnect_slack",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Approvals
Actions/actions/get_org_chartGet org chart
Who reports to whom: every member with their manager (reportsTo), the people who report to them, and everyone above them, nearest first.
curl -X POST "https://api.crossingedge.com/v1/actions/get_org_chart" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_org_chart", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_org_chart",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_reports_toSet reports to
Sets who a member reports to (their manager), or nobody.
Body
memberstringrequiredThe member: email, name or user id
reportsTostringrequiredTheir manager: email, name or user id, or "nobody"
curl -X POST "https://api.crossingedge.com/v1/actions/set_reports_to" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"member": "…",
"reportsTo": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_reports_to", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"member": "…",
"reportsTo": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_reports_to",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"member": "…",
"reportsTo": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_approval_rulesList approval rules
The workspace’s approval rules, in order: each one holds a change to a record (a field changing, a record reaching a stage, or a record being deleted) until the right people say yes.
Body
objectstringOnly rules on this object: contacts, companies, deals, products or a custom object id
curl -X POST "https://api.crossingedge.com/v1/actions/list_approval_rules" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_approval_rules", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_approval_rules",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_approval_ruleGet approval rule
One approval rule by its name or id, with its sentence and every part (trigger, conditions, form, steps, no answer, AI switches).
Body
rulestringrequiredThe rule’s name or id
curl -X POST "https://api.crossingedge.com/v1/actions/get_approval_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"rule": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_approval_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"rule": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_approval_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"rule": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/save_approval_ruleSave approval rule
Makes an approval rule, or changes one (name or id in rule; what you leave out stays as it was).
Body
rulestringTo change one: its name or id. Leave out to make a new one
namestringA short name, like Big discounts
objectstringcontacts, companies, deals, products or a custom object id
triggerobjectWhen it asks: a field changes, the record reaches a stage, or the record is deleted
conditionsarray of objectOnly when other fields hold these
formarray of objectWhat the requester is asked
stepsarray of objectWho approves, in order
noAnswerobjectHours until a reminder, passing it up, and lapsing
aiobjectThe AI switches
enabledbooleanFalse keeps it but holds nothing
positionnumberIts place in the order, 1 for first
curl -X POST "https://api.crossingedge.com/v1/actions/save_approval_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"rule": "…",
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/save_approval_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"rule": "…",
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/save_approval_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"rule": "…",
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/turn_off_approval_ruleTurn off approval rule
Turns an approval rule off (or back on with on: true).
Body
rulestringrequiredThe rule’s name or id
onbooleanTrue to turn it back on
curl -X POST "https://api.crossingedge.com/v1/actions/turn_off_approval_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"rule": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/turn_off_approval_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"rule": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/turn_off_approval_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"rule": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/try_approval_ruleTry approval rule
A dry run of an approval rule on one record: whether these changes (or, for a delete rule, deleting it) would wait for approval, what the requester would be asked, and who each step would ask, steps not needed included, in plain lines to show the person.
Body
rulestringA saved rule’s name or id
draftobjectOr a rule not saved yet, shaped as save_approval_rule takes it
recordstringrequiredThe record’s id
changesobjectWhat would change, field (label or key) to value, like {"Discount": 22}. Not needed for a delete rule
asstringWho would ask: email, name or id. Default: the record’s owner
curl -X POST "https://api.crossingedge.com/v1/actions/try_approval_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"record": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/try_approval_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"record": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/try_approval_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"record": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_approvalsList approvals
With object and record: every approval on that record, open ones (waiting on whom) and past ones (approved, rejected, taken back, lapsed).
Body
tabstringwaiting_for_me, sent_by_me, done or all
groupstringOnly the requests of one import or bulk edit (its group id)
nextstringThe next value a previous page gave
objectstringWith record: the record’s object (contacts, companies, deals, products or a custom object id)
recordstringEvery approval on one record instead: what waits now (and on whom) and what ended, newest first
curl -X POST "https://api.crossingedge.com/v1/actions/list_approvals" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"tab": "…",
"group": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_approvals", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"tab": "…",
"group": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_approvals",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"tab": "…",
"group": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_approvalGet approval
One approval request in full: what changes (from and to), the form’s answers (Why?), each step in order with who it asks and its state (waiting, approved, not needed, sent back), the history with notes (an owner or admin answering for someone says "for" whom), and whether this person may answer, take it back or ask again.
Body
idstringrequiredThe request id (areq_…)
curl -X POST "https://api.crossingedge.com/v1/actions/get_approval" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_approval", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_approval",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/ask_for_approvalAsk for approval
Asks for approval on a record by hand, with nothing changed: with a rule (its form and its steps, judged on the record as it is), or by asking one member (approver) and saying what it is for (what).
Body
objectstringcontacts, companies, deals, products or a workspace object
recordstringThe record’s id
rulestringAn approval rule’s name or id
approverstringOr the member to ask: email, name or id
whatstringWhat it is for, when asking a member
whystringWhy you are asking (the form’s Why?)
answersobjectAnswers to the rule’s other form questions, by key
requeststringTo ask again after a send back: the request id
changesobjectAsking again: the new values, like {"Discount": 18}
curl -X POST "https://api.crossingedge.com/v1/actions/ask_for_approval" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"record": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/ask_for_approval", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"record": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/ask_for_approval",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"record": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/answer_approvalAnswer approval
Answers an approval request as this person: approve, send_back (change it and ask again) or reject.
Body
idstringThe request id
groupstringOr a group id from list_approvals, to answer all of it
answerstringrequiredapprove, send_back or reject
notestringWhy: needed to send back or reject
forstringAn owner or admin answering for an approver: their email, name or id
curl -X POST "https://api.crossingedge.com/v1/actions/answer_approval" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"answer": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/answer_approval", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"answer": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/answer_approval",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"answer": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/withdraw_approvalWithdraw approval
Takes back an approval request that is waiting or was sent back: nothing changes and the field it held is free again.
Body
idstringrequiredThe request id
notestringWhy, optional
curl -X POST "https://api.crossingedge.com/v1/actions/withdraw_approval" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/withdraw_approval", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/withdraw_approval",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_approval_insightsGet approval insights
Approvals in numbers for a period (the last 30 days by default): how many were asked, the share approved, the typical wait from asking to an answer, each approver’s typical wait and how many they answered, how many wait now and the longest, and suggestions from history (an approver who approves nearly everything under a value within the hour: raise the limit for their step?).
Body
daysnumberHow many days back, 1 to 365. Default 30
curl -X POST "https://api.crossingedge.com/v1/actions/get_approval_insights" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"days": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_approval_insights", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"days": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_approval_insights",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"days": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Queues
Actions/actions/list_queuesList queues
The workspace’s queues: each one puts the cards waiting in a stage in a fair line, so only the front may move.
Body
objectstringOnly queues on this object: contacts, companies, deals, products or a custom object id
curl -X POST "https://api.crossingedge.com/v1/actions/list_queues" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"object": "deals"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_queues", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"object": "deals"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_queues",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"object": "deals"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_queueGet queue
One queue by name or id.
Body
queuestringrequiredThe queue’s name or id
stagestringA stage of the queue, to read its line
curl -X POST "https://api.crossingedge.com/v1/actions/get_queue" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"queue": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_queue", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"queue": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_queue",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"queue": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/save_queue_ruleSave queue rule
Makes a queue, or changes one (name or id in queue; what you leave out stays as it was).
Body
queuestringTo change one: its name or id. Leave out to make a new one
namestringA short name, like Printing line
objectstringcontacts, companies, deals, products or a custom object id
stagesarray of stringThe stages that are each a line
filterarray of objectOnly cards matching these are in the queue
orderarray of objectWhat puts a card first
lanesobjectSplit the line into lanes
frontnumberOpen cards at the front of each lane
locksarray of stringWhat a lock stops besides moving
gatesarray of objectWhat a card at the front waits for
skipBlockedbooleanA gated card at the front lets the next one go ahead
overridesobjectWho may skip the line
claimobjectTaking an open card holds it
ageingobjectWaiting cards move up
windowobjectWhen the line is open
batchesarray of objectRelease some cards at set times
alertsarray of objectStuck or reached the front
enabledbooleanFalse pauses it: nothing is locked
curl -X POST "https://api.crossingedge.com/v1/actions/save_queue_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"queue": "…",
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/save_queue_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"queue": "…",
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/save_queue_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"queue": "…",
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/pause_queuePause queue
Pauses a queue (or turns it back on with on: true).
Body
queuestringrequiredThe queue’s name or id
onbooleanTrue to turn it back on
curl -X POST "https://api.crossingedge.com/v1/actions/pause_queue" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"queue": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/pause_queue", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"queue": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/pause_queue",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"queue": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/try_queue_ruleTry queue rule
A dry run of a queue on real cards: where each card would stand (place, lane, open or locked) and why, worked out over the whole stage so places are right, the rule as one plain sentence, and gaps: what would not work the first time (cards no lane catches, a gate nothing meets, an order field empty on most cards, a stage name in more than one pipeline: ask which).
Body
queuestringA saved queue’s name or id
draftobjectOr a queue not saved yet, shaped as save_queue_rule takes it
recordsarray of stringThe cards’ ids. Leave out to try a spread of real cards
curl -X POST "https://api.crossingedge.com/v1/actions/try_queue_rule" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"queue": "…",
"draft": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/try_queue_rule", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"queue": "…",
"draft": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/try_queue_rule",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"queue": "…",
"draft": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/claim_cardClaim card
Takes an open card in a queue, so nobody else starts it.
Body
queuestringrequiredThe queue’s name or id
recordnumberrequiredThe card’s id
curl -X POST "https://api.crossingedge.com/v1/actions/claim_card" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"queue": "…",
"record": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/claim_card", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"queue": "…",
"record": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/claim_card",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"queue": "…",
"record": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/release_cardRelease card
Lets go of a card you hold, so it is open to the line again.
Body
queuestringrequiredThe queue’s name or id
recordnumberrequiredThe card’s id
reasonstringWhy, when it is not your own claim
curl -X POST "https://api.crossingedge.com/v1/actions/release_card" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"queue": "…",
"record": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/release_card", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"queue": "…",
"record": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/release_card",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"queue": "…",
"record": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/skip_lineSkip the line
Moves a card out of its place in a queue ahead of its turn, or past someone’s claim, to the stage in to.
Body
queuestringrequiredThe queue’s name or id
recordnumberrequiredThe card’s id
tostringrequiredThe stage to move it to (a deal’s stage name, or a choice of the stage field)
reasonstringrequiredWhy it goes ahead
curl -X POST "https://api.crossingedge.com/v1/actions/skip_line" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"queue": "…",
"record": 101,
"to": "…",
"reason": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/skip_line", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"queue": "…",
"record": 101,
"to": "…",
"reason": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/skip_line",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"queue": "…",
"record": 101,
"to": "…",
"reason": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Customer portal
Actions/actions/get_portalGet the portal
The customer portal: its settings (name, address, Draft or Live, look, who can sign in, Ask), its tabs (what customers see: each tab’s object, fields and whose records), how many people are invited, and its design in brief (pages, navigation, routes, home, whether the draft differs from what is live, the checks on this draft, the latest versions).
curl -X POST "https://api.crossingedge.com/v1/actions/get_portal" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_portal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_portal",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/portal_guidePortal guide
How to write the customer portal’s pages: what a design is, how a page runs, the window.portal calls and their answers, the kit’s ready parts and classes, the rules every page keeps, and examples.
curl -X POST "https://api.crossingedge.com/v1/actions/portal_guide" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/portal_guide", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/portal_guide",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_portal_pageRead a portal page
One page of the portal’s draft design, its HTML in full (in parts when it is long: pass from to read on), or the shared stylesheet (shared: css) or script (shared: js).
Body
pagestringThe page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order
sharedstringInstead of a page: the shared stylesheet (css) or script (js)
One of css js
fromnumberWhere to read on from, the next a longer page gave
curl -X POST "https://api.crossingedge.com/v1/actions/read_portal_page" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"page": "…",
"shared": "css"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_portal_page", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"page": "…",
"shared": "css"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_portal_page",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"page": "…",
"shared": "css"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/write_portal_pageWrite a portal page
Writes a whole page of the portal’s design, new or replacing one, following portal_guide.
Body
pagestringrequiredThe page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order
htmlstringrequiredThe page’s HTML, with its own <style> and <script>
titlestringIts title, shown in the browser tab. Default: from the name
curl -X POST "https://api.crossingedge.com/v1/actions/write_portal_page" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"page": "…",
"html": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/write_portal_page", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"page": "…",
"html": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/write_portal_page",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"page": "…",
"html": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/edit_portal_pageEdit a portal page
Changes part of one page by exact find and replace: each find must match the page’s code exactly once (or every time with all: true).
Body
pagestringrequiredThe page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order
stepsarray of objectThe changes, in order, up to 50
titlestringA new title, if it changes
curl -X POST "https://api.crossingedge.com/v1/actions/edit_portal_page" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"page": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/edit_portal_page", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"page": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/edit_portal_page",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"page": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_portal_pageDelete a portal page
Takes a page out of the portal’s design; the navigation, routes and home stop pointing at it.
Body
pagestringrequiredThe page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order
curl -X POST "https://api.crossingedge.com/v1/actions/delete_portal_page" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"page": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_portal_page", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"page": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_portal_page",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"page": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/undo_portal_designUndo a portal design change
Takes the portal’s draft back one change; again for the one before (the last 20 are kept).
curl -X POST "https://api.crossingedge.com/v1/actions/undo_portal_design" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/undo_portal_design", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/undo_portal_design",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_portalChange the portal
Changes the portal’s settings: name, address (slug; the old one stops working at once), welcome line, colour (accent), light or dark, Draft or Live (live needs a tab with a field; going live emails nobody; back in Draft nobody can sign in or see the portal until it is live again), who can sign in (audience: invited, or any contact with a company), sign-in codes by WhatsApp too, Ask (on, monthlyCap) and the contact person (none, owner, or a member).
Body
namestringThe portal’s name, up to 60 characters
slugstringIts address: portal.crossingedge.com/<slug>, lowercase letters, numbers and dashes
welcomestringThe line on the sign-in page, up to 160 characters
accentstringIts colour, like #1f3a5f
themestringOne of light dark
statusstringdraft: nobody outside can sign in or see the portal (people already signed in get back in when it is live again); live: people who may sign in can
One of draft live
audiencestringinvited: only contacts invited; any: any contact with a company
One of invited any
signInarray of stringHow codes go out. Email is always on; WhatsApp needs a connected number
askobjectcontactPersonstringWho customers are shown to contact: none, owner (each contact’s owner), or a member by email or name
curl -X POST "https://api.crossingedge.com/v1/actions/update_portal" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"slug": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_portal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"slug": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_portal",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"slug": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_portal_dataSet what customers see
Sets what customers see: adds a tab (leave tab out; give label, object and fields) or changes one (tab, then only what changes).
Body
tabstringThe tab, by its key, label or id (get_portal lists them)
labelstringThe tab’s name, up to 40 characters
objectstringFor a new tab: its object
keystringWhat pages ask for it by, like orders. Default: from the label
fieldsarray of stringEvery field the tab shows, in order, by key or label
scopestringOne of company own
filterarray of objectOnly records matching all of these. A choice field: { key, values }. A number or date: { key, min, max }. Text: { key, text }
verbsarray of stringview is always on; download lets them download its files
stageNamesobjectNames customers see for stages, by stage name or id
curl -X POST "https://api.crossingedge.com/v1/actions/set_portal_data" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tab": "…",
"label": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_portal_data", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"tab": "…",
"label": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_portal_data",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"tab": "…",
"label": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_portal_dataStop showing a tab
Takes a tab out of the portal: customers stop seeing it at once.
Body
tabstringrequiredThe tab, by its key, label or id (get_portal lists them)
curl -X POST "https://api.crossingedge.com/v1/actions/remove_portal_data" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tab": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_portal_data", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"tab": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_portal_data",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"tab": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/invite_to_portalInvite to the portal
Invites a contact to the portal: they may sign in from now on (a removal is lifted).
Body
contactIdnumberrequiredThe contact, by id (search_contacts finds them)
curl -X POST "https://api.crossingedge.com/v1/actions/invite_to_portal" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"contactId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/invite_to_portal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"contactId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/invite_to_portal",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"contactId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/remove_portal_accessRemove portal access
Removes a contact’s access to the portal: they are signed out now and stay out until someone invites them again, in either sign-in mode.
Body
contactIdnumberrequiredThe contact, by id (search_contacts finds them)
curl -X POST "https://api.crossingedge.com/v1/actions/remove_portal_access" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"contactId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/remove_portal_access", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"contactId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/remove_portal_access",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"contactId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/publish_portalPublish the portal
Publishes the portal’s draft design: customers see it at once, and it is kept as a new version.
Body
notestringWhat changed, kept with the version
curl -X POST "https://api.crossingedge.com/v1/actions/publish_portal" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"note": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/publish_portal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"note": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/publish_portal",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"note": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/restore_portal_versionRestore a portal version
Puts an earlier published version back: it goes live at once as a new version and becomes the draft (Undo brings the draft back).
Body
versionnumberrequiredThe version number
curl -X POST "https://api.crossingedge.com/v1/actions/restore_portal_version" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"version": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/restore_portal_version", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"version": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/restore_portal_version",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"version": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}Reports and schema
Actions/actions/report_guideReport guide
How reports work: native report specs (KPIs, notes, charts, ranked bars, tables and outlines of groups in groups, a tree of accounts with their subsidiaries and group totals, a map of where records are that drills from the world to a country, its states and its cities, the stage flow), the query language with the account hierarchy, the HTML runtime for anything else, and the house style.
curl -X POST "https://api.crossingedge.com/v1/actions/report_guide" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/report_guide", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/report_guide",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_schemaGet schema
The workspace data model: every object and field (with types and choices), pipelines and stages, members, currency and today’s date.
curl -X POST "https://api.crossingedge.com/v1/actions/get_schema" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_schema", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_schema",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/run_queryRun query
Runs one report query and returns the answer, exactly as a report would get it.
Body
queryobjectrequiredA report query. See report_guide for the full language. Every key can be a field or a path through links to a linked record’s field, up to three links: "contactIds.source" on deals (their contacts’ lead source), "dealIds.stageKind" on contacts (their deals’ stage kind), "companyIds.dealIds.amount". Links read both ways: contacts and companies have dealIds, products have dealIds, and get_schema lists every link. A person field is a link to members: "ownerId.team" on deals (the owner’s team), "ownerId.<field id>" for any member field; members have dealIds (deals they own) and activityIds. Companies have parentCompanies, subsidiaries, groupCompanies (itself and all below), topParent and depth: "subsidiaries.name", deals grouped by "companyIds.topParent".
curl -X POST "https://api.crossingedge.com/v1/actions/run_query" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/run_query", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/run_query",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"query": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_reportsList reports
Reports in the workspace this person can see: their own and the shared ones, each with its kind (spec, html, markdown or embed), for an embed its link and the date its data was taken, and for markdown the date it was written.
curl -X POST "https://api.crossingedge.com/v1/actions/list_reports" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_reports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_reports",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_reportGet report
One report whole, to read or change it: its spec, its full HTML, its markdown, or for an embed its link and the date its data was taken.
Body
idstringrequiredReport id
curl -X POST "https://api.crossingedge.com/v1/actions/get_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/check_reportCheck report
Checks a native report spec and works out every figure on it for a period and the one before, exactly as the page will show them: for a map scoped to a country or state, each state or city by name and any written names it cannot place; for a tree, each company indented by level with its group total and the total, each company counted once.
Body
specobjectrequiredThe report spec (see report_guide)
periodobject{ kind: week | month | quarter | year | custom, year?, quarter?, from?, to? }. Default: the spec’s, else this month
pipelinestringA pipeline name, as the pipeline picker would set it
filtersarray of objectFilter bar filters on the spec’s object
curl -X POST "https://api.crossingedge.com/v1/actions/check_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"spec": {}
}'const res = await fetch("https://api.crossingedge.com/v1/actions/check_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"spec": {}
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/check_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"spec": {}
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_reportCreate report
Publishes a new report into Crossing Edge.
Body
namestringrequiredShort title, e.g. "Pipeline health"
descriptionstringOne line on what it answers
specobjectA native report spec (see report_guide). Check it with check_report first
htmlstringInstead of a spec: the complete, self-contained HTML page
markdownstringInstead of a spec, HTML or an embed: written words, in markdown (headings, lists, task boxes, tables, quotes, code, links), for an account plan, a brief, meeting prep, a memo or a playbook. Drawn as formatted text in the app; raw HTML in it shows as text. At most 512 KB. It does not refresh, so write the figures it quotes with their date
embedstringInstead of a spec or HTML: the embed code (the iframe snippet from Get embed code) or the link of a published Claude artifact (claude.ai). The artifact must hold a static, dated snapshot of the data written into it; never fetch live data from MCP or anywhere else at view time. Add app.crossingedge.com to its Allowed domains in Claude.
snapshotAtstringFor an embed, the date its data was taken; for markdown, the date it was written (YYYY-MM-DD, or a date and time). Default: now. Shown as "Data as of" or "Written" on the report
sharedbooleanShow it to everyone in the workspace (each sees only their own data access)
curl -X POST "https://api.crossingedge.com/v1/actions/create_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_reportUpdate report
Changes a report: any of its name, description, spec, HTML, markdown, embed, snapshotAt or sharing.
Body
idstringrequiredReport id
namestringNew title
descriptionstringNew description
specobjectThe complete new spec
htmlstringThe complete new HTML
markdownstringThe complete new markdown (see create_report)
embedstringInstead of a spec or HTML: the embed code (the iframe snippet from Get embed code) or the link of a published Claude artifact (claude.ai). The artifact must hold a static, dated snapshot of the data written into it; never fetch live data from MCP or anywhere else at view time. Add app.crossingedge.com to its Allowed domains in Claude.
snapshotAtstringFor an embed, the date its data was taken; for markdown, the date it was written (YYYY-MM-DD, or a date and time). Default: now. Shown as "Data as of" or "Written" on the report
editsarray of objectChanges to part of the HTML page or the markdown, applied in order: each find is exact text from it that appears once, replaced by replace
sharedbooleancurl -X POST "https://api.crossingedge.com/v1/actions/update_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_access_fieldsPerson fields that give access
The person fields that give the people named in them access to a record (e.g.
curl -X POST "https://api.crossingedge.com/v1/actions/list_access_fields" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_access_fields", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_access_fields",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_access_fieldsSet the person fields that give access
Owners and admins: chooses which person fields on an object give the people named in them access to the record, and at which level, replacing the object’s current choice (an empty list turns it off).
Body
objectstringrequiredcontacts, companies, deals, products, or a workspace object by id, name or plural
fieldsarray of objectrequiredcurl -X POST "https://api.crossingedge.com/v1/actions/set_access_fields" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_access_fields", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_access_fields",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_profilesList profiles
The workspace’s profiles (like Standard, Read only or Sales manager): what each can do, who is on it, and which one new members land on.
curl -X POST "https://api.crossingedge.com/v1/actions/list_profiles" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_profiles", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_profiles",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/create_profileMake a profile
Owners and admins: makes a profile from a preset (full, standard, own, readOnly), another profile’s name to copy, or a full permissions object, and optionally puts members on it.
Body
namestringrequiredProfile name, e.g. Sales manager
permissionsanyrequiredPreset name, a profile to copy, or a permissions object
membersarray of stringcurl -X POST "https://api.crossingedge.com/v1/actions/create_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Acme",
"permissions": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/create_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Acme",
"permissions": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/create_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Acme",
"permissions": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/update_profileChange a profile
Owners and admins: renames a profile, changes what it can do (for everyone on it at once), or makes it the one new members land on (isDefault: true).
Body
profilestringrequiredProfile name or id
namestringNew name
permissionsanyPreset name, a profile to copy, or a permissions object
isDefaultbooleanMake it the profile new members land on
curl -X POST "https://api.crossingedge.com/v1/actions/update_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"profile": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/update_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"profile": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/update_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"profile": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/delete_profileRemove a profile
Owners and admins: removes a profile.
Body
profilestringrequiredProfile name or id
curl -X POST "https://api.crossingedge.com/v1/actions/delete_profile" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"profile": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/delete_profile", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"profile": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/delete_profile",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"profile": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_whatsappGet WhatsApp
The person’s WhatsApp in Crossing Edge: their connected numbers (with Meta’s quality rating, daily limit for new conversations, chat history import progress, and what Meta charged this month), every number for owners and admins, and where to connect one.
curl -X POST "https://api.crossingedge.com/v1/actions/get_whatsapp" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_whatsapp", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_whatsapp",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_whatsapp_chatsList WhatsApp chats
WhatsApp chats in Crossing Edge, newest first: who, last message, when the customer last wrote (free replies are allowed for 24 hours after that), unread, linked records.
Body
minebooleanOnly the person’s own chats
reviewbooleanTheir chats waiting for them to bring in or ignore
qstringSearch
recordobjectOnly the chats on this record
curl -X POST "https://api.crossingedge.com/v1/actions/list_whatsapp_chats" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"mine": true,
"review": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_whatsapp_chats", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"mine": true,
"review": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_whatsapp_chats",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"mine": True,
"review": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_whatsapp_chatRead WhatsApp chat
One WhatsApp chat with its messages, oldest first: direction, text, what was sent from the phone, delivery status.
Body
idstringrequiredChat id, from list_whatsapp_chats
curl -X POST "https://api.crossingedge.com/v1/actions/read_whatsapp_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_whatsapp_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_whatsapp_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/reply_whatsapp_chatReply on WhatsApp
Replies in one of the person’s own WhatsApp chats, from their own number.
Body
idstringrequiredChat id
textstringrequiredThe message, up to 4,096 characters
confirmbooleanrequiredTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/reply_whatsapp_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"text": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/reply_whatsapp_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"text": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/reply_whatsapp_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"text": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/list_whatsapp_templatesList WhatsApp templates
The message templates a chat’s number can send (approved first), each with its category (Meta charges by category and country), status with Meta, body and number of blanks ({{1}} is usually the first name).
Body
idstringrequiredChat id
freshbooleanAsk Meta again
curl -X POST "https://api.crossingedge.com/v1/actions/list_whatsapp_templates" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "101"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/list_whatsapp_templates", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "101"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/list_whatsapp_templates",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"id": "101"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/send_whatsapp_templateSend WhatsApp template
Sends an approved template into one of the person’s own WhatsApp chats, its blanks filled in order (params).
Body
idstringrequiredChat id
namestringrequiredTemplate name
languagestringrequiredTemplate language code, e.g. en
paramsarray of stringOne value per blank, in order
confirmbooleanrequiredTrue once the person has seen it and said send
curl -X POST "https://api.crossingedge.com/v1/actions/send_whatsapp_template" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"name": "Acme",
"language": "…",
"confirm": true
}'const res = await fetch("https://api.crossingedge.com/v1/actions/send_whatsapp_template", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"name": "Acme",
"language": "…",
"confirm": true
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/send_whatsapp_template",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"name": "Acme",
"language": "…",
"confirm": True
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/set_whatsapp_chat_statusBring in or ignore a WhatsApp chat
One of the person’s own WhatsApp chats from Review: tracked brings it into the CRM (a lead is made when the number is new, and it is logged on its records), ignored lets it go (its messages are not kept).
Body
idstringrequiredChat id
statusstringrequiredOne of tracked ignored
curl -X POST "https://api.crossingedge.com/v1/actions/set_whatsapp_chat_status" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"status": "tracked"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/set_whatsapp_chat_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"status": "tracked"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/set_whatsapp_chat_status",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"status": "tracked"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/link_whatsapp_chatLink WhatsApp chat
Links one of the person’s WhatsApp chats to a contact, company or deal, so its messages show there (a contact’s companies and open deals come too).
Body
idstringrequiredChat id
objectstringrequiredOne of contacts companies deals
recordIdnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/link_whatsapp_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"object": "contacts",
"recordId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/link_whatsapp_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"object": "contacts",
"recordId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/link_whatsapp_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"object": "contacts",
"recordId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/unlink_whatsapp_chatUnlink WhatsApp chat
Takes a WhatsApp chat off a record it was linked to.
Body
idstringrequiredChat id
objectstringrequiredOne of contacts companies deals
recordIdnumberrequiredRecord id
curl -X POST "https://api.crossingedge.com/v1/actions/unlink_whatsapp_chat" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"id": "101",
"object": "contacts",
"recordId": 101
}'const res = await fetch("https://api.crossingedge.com/v1/actions/unlink_whatsapp_chat", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"id": "101",
"object": "contacts",
"recordId": 101
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/unlink_whatsapp_chat",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "101",
"object": "contacts",
"recordId": 101
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/highlight_reportHighlight a report
Puts a highlight card on a report, in a strip at the top of its page, or on the report an agent keeps (its whole page is that agent's cards): what people reading it should notice, with its numbers and reasons.
Body
reportstringrequiredThe report: its id (rp_…), or its name as the Reports list shows it
markupstringrequiredThe card, in highlight markup: <highlight title="…">…</highlight>
curl -X POST "https://api.crossingedge.com/v1/actions/highlight_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"report": "…",
"markup": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/highlight_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"report": "…",
"markup": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/highlight_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"report": "…",
"markup": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/clear_report_highlightClear a report card
Takes down your own card on a report: the one with this topic, or all of yours there when no topic is given.
Body
reportstringrequiredThe report: its id (rp_…), or its name as the Reports list shows it
topicstringThe topic it was written with; leave out to clear all of yours on this report
curl -X POST "https://api.crossingedge.com/v1/actions/clear_report_highlight" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"report": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/clear_report_highlight", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"report": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/clear_report_highlight",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"report": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/highlight_insightsHighlight the Insights page
Puts a highlight card at the top of the Insights page: what owners and admins should notice about numbers across the whole workspace (a trend, a slipping rate, a region falling behind), not about one record or one report.
Body
markupstringrequiredThe card, in highlight markup: <highlight title="…">…</highlight>
curl -X POST "https://api.crossingedge.com/v1/actions/highlight_insights" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"markup": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/highlight_insights", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"markup": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/highlight_insights",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"markup": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/clear_insights_highlightClear an Insights card
Takes down your own card on the Insights page: the one with this topic, or all of yours there when no topic is given.
Body
topicstringThe topic it was written with; leave out to clear all of yours on the Insights page
curl -X POST "https://api.crossingedge.com/v1/actions/clear_insights_highlight" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"topic": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/clear_insights_highlight", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"topic": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/clear_insights_highlight",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"topic": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/read_reportRead a report
Reads a report as plain data, as you would see it: a native report’s figures section by section (worked out now, for its default period), the words of an HTML or written report, or the cards on a report an agent keeps.
Body
reportstringrequiredThe report: its id (rp_…), or its name as the Reports list shows it
curl -X POST "https://api.crossingedge.com/v1/actions/read_report" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{
"report": "…"
}'const res = await fetch("https://api.crossingedge.com/v1/actions/read_report", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"report": "…"
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/read_report",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={
"report": "…"
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/find_missing_detailsFind missing details
Fills empty fields on one contact or company from outside data sources (Find): a work email, mobile number, job title, LinkedIn or location for a contact; phone, company size, industry, location or LinkedIn for a company.
Body
objectstringrequiredcontacts or companies
idnumberrequiredRecord id
fieldsarray of stringrequiredThe empty fields to fill, by key (email, phone, jobTitle, linkedin, city, companySize, industry…)
curl -X POST "https://api.crossingedge.com/v1/actions/find_missing_details" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"id": 101,
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/find_missing_details", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"id": 101,
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/find_missing_details",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"id": 101,
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/get_find_optionsFind options and credits
What Find can fill in this workspace, the credits each field costs when found, and the credits left this month.
curl -X POST "https://api.crossingedge.com/v1/actions/get_find_options" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.crossingedge.com/v1/actions/get_find_options", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/get_find_options",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}"},
json={},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}/actions/find_missing_details_bulkFind missing details on many records
Queues Find for up to 200 contacts or companies at once, for the fields named; the finds run in the background over the next minutes and write as they find.
Body
objectstringrequiredcontacts or companies
idsarray of numberrequiredRecord ids, up to 200
fieldsarray of stringrequiredField keys to fill
curl -X POST "https://api.crossingedge.com/v1/actions/find_missing_details_bulk" \
-H "Authorization: Bearer $CROSSING_EDGE_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"object": "deals",
"ids": [],
"fields": []
}'const res = await fetch("https://api.crossingedge.com/v1/actions/find_missing_details_bulk", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
"object": "deals",
"ids": [],
"fields": []
}),
});
const { data, error } = await res.json();import os, uuid, requests
res = requests.post(
"https://api.crossingedge.com/v1/actions/find_missing_details_bulk",
headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"object": "deals",
"ids": [],
"fields": []
},
)
data = res.json()["data"]{
"data": {
"id": 101,
"…": "…"
},
"request_id": "req_7c1f0e2a9b4d"
}