Crossing Edge API

Crossing Edge API

Read and change your CRM from your own systems.

Quickstart

Base URLhttps://api.crossingedge.com/v1

Send 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" } }
400Invalid request; field names the problem
401Missing, revoked or expired key
403The key may not do this
404Not found
409Conflict, like a duplicate email
429Rate 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

GET/me

The key in use

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Contacts

GET/contacts

List or search contacts

Read key

Finds contacts by name, email, phone, job title or company, optionally narrowed by status or owner.

Query parameters

querystring

Words to match in the name, email, phone, job title or company names

statusstring

Only this lifecycle status

ownerstring

Only contacts this member owns, by email or name

companyIdnumber

Only contacts at this company

limitnumber

How 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/contacts

Create a contact

Read and write key

Adds a contact.

Body

firstNamestringrequired

First name

lastNamestring

Last name

emailstring

Email. A contact needs an email or a phone

phonestring

Phone, with country code

jobTitlestring

Job title

statusstring

Lifecycle status, one of the choices get_schema lists for contacts.status

sourcestring

Where they came from, one of the choices get_schema lists for contacts.source

linkedinstring

LinkedIn profile URL

telegramstring

Telegram username, like @priya

countrystring

Country they are based in, by name or two-letter code (India, IN)

statestring

Their state, province or region

citystring

Their city

ownerstring

Owner, by member email or name

companyIdsarray of number

Companies they work with, by id (replaces the current set)

companyNamestring

A company to link by exact name; made if the workspace has none by that name

customobject

Custom field values by field key (keys from get_schema)

approvalobject

When 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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/contacts/{id}

Get a contact

Read key

Everything about one contact: their fields, companies, owner, and their latest activities and open tasks.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/contacts/{id}

Update a contact

Read and write key

Changes a contact.

Path parameters

idstringrequired

The record id

Body

firstNamestring

First name

lastNamestring

Last name

emailstring

Email. A contact needs an email or a phone

phonestring

Phone, with country code

jobTitlestring

Job title

statusstring

Lifecycle status, one of the choices get_schema lists for contacts.status

sourcestring

Where they came from, one of the choices get_schema lists for contacts.source

linkedinstring

LinkedIn profile URL

telegramstring

Telegram username, like @priya

countrystring

Country they are based in, by name or two-letter code (India, IN)

statestring

Their state, province or region

citystring

Their city

ownerstring

Owner, by member email or name

companyIdsarray of number

Companies they work with, by id (replaces the current set)

companyNamestring

A company to link by exact name; made if the workspace has none by that name

customobject

Custom field values by field key (keys from get_schema)

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/contacts/{id}

Delete a contact

Read and write key

Deletes a contact for good, with their notes and history.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/contacts/{id}/stage-times

The stages of a contact: each stay with when it came in, when it left and for how long

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Companies

GET/companies

List or search companies

Read key

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

querystring

Words to match

ownerstring

Only records this member owns, by email or name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/companies

Create a company

Read and write key

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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/companies/{id}

Get a company

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/companies/{id}

Update a company

Read and write key

Changes a record of any object.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/companies/{id}

Delete a company

Read and write key

Deletes a record of any object for good, with its notes and history.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/companies/{id}/stage-times

The stages of a company: each stay with when it came in, when it left and for how long

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Find

GET/find

What Find can fill, its prices in credits, and the credits left

Read key

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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/contacts/{id}/find

Fill a contact’s empty fields from outside data sources

Read and write key

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

idstringrequired

The record id

Body

objectstringrequired

contacts or companies

fieldsarray of stringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/companies/{id}/find

Fill a company’s empty fields from outside data sources

Read and write key

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

idstringrequired

The record id

Body

objectstringrequired

contacts or companies

fieldsarray of stringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/find/bulk

Find missing details on many contacts or companies

Read and write key

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

objectstringrequired

contacts or companies

idsarray of numberrequired

Record ids, up to 200

fieldsarray of stringrequired

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Deals

GET/deals

List or search deals

Read key

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

querystring

Words to match

ownerstring

Only records this member owns, by email or name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/deals

Create a deal

Read and write key

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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/deals/{id}

Get a deal

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/deals/{id}

Update a deal

Read and write key

Changes a record of any object.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/deals/{id}

Delete a deal

Read and write key

Deletes a record of any object for good, with its notes and history.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/deals/{id}/stage-times

The stages of a deal: each stay with when it came in, when it left and for how long

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Products

GET/products

List or search products

Read key

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

querystring

Words to match

ownerstring

Only records this member owns, by email or name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/products

Create a product

Read and write key

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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/products/{id}

Get a product

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/products/{id}

Update a product

Read and write key

Changes a record of any object.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/products/{id}

Delete a product

Read and write key

Deletes a record of any object for good, with its notes and history.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/products/{id}/stage-times

The stages of a product: each stay with when it came in, when it left and for how long

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Products and stock

GET/products/{id}/usage

How a product is selling across deals

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/deals/{id}/products

Set a deal’s products; its amount becomes their total

Read and write key

Sets the products on a deal: products replaces the whole list (an empty list takes them all off).

Path parameters

idstringrequired

The record id

Body

dealnumberrequired

Deal id

productsarray of objectrequired

The deal’s products, in order

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/price-books

List price books, with the companies and products each covers

Read key

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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/price-books

Add a price book, optionally with a company rule

Read and write key

Adds a price book.

Body

namestringrequired

Book name, e.g. Wholesale

ruleFieldstring

Company select field key the rule reads

ruleValuestring

The choice that picks this book

isDefaultboolean

Make 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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/price-books/{id}

Rename a price book, change its rule or make it the default

Read and write key

Renames a price book, changes its company rule (send ruleField and ruleValue as null to remove it), or makes it the default.

Path parameters

idstringrequired

The record id

Body

bookstringrequired

Price book name or id

namestring

New name

ruleFieldstring

Company select field key, or null for no rule

ruleValuestring

The choice, or null

isDefaultboolean

Make 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/price-books/{id}/archive

Archive a price book; its prices stay on the lines already quoted

Read and write key

Archives a price book: no longer offered or matched, while its prices stay for the deal lines already quoted from it.

Path parameters

idstringrequired

The record id

Body

bookstringrequired

Price 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/products/{id}/prices

A product’s variants, price books and the price in each box

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PUT/products/{id}/prices

Set (or clear) the price of a product or variant in a price book

Read and write key

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

idstringrequired

The record id

Body

productstringrequired

Product name, code or id

variantstring

Variant name, code or id; leave out for a product without variants

bookstringrequired

Price book name or id

ratesobject

The 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.

clearboolean

Take 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PUT/products/{id}/variants

Set a product’s variants as the whole list

Read and write key

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

idstringrequired

The record id

Body

productstringrequired

Product name, code or id

variantsarray of objectrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/products/{id}/quote

Work out the price of a quantity from the rate card, step by step

Read key

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

idstringrequired

The record id

Query parameters

variantstring

Variant name, code or id

bookstring

Price book name or id; the default book when left out

qtynumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PUT/deals/{id}/price-book

Pick a deal’s price book and price its card-priced lines from it

Read and write key

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

idstringrequired

The record id

Body

dealnumberrequired

Deal id

bookstringrequired

Price book name or id

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/deals/{id}/products/reprice

Price a deal’s card-priced lines again from today’s rates

Read and write key

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

idstringrequired

The record id

Body

dealnumberrequired

Deal id

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/products/{id}/stock

A product’s stock per warehouse, and per variant

Read key

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

idstringrequired

The record id

Query parameters

historyboolean

Also the latest 20 stock changes

variantstring

Optional: 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/stock

Record stock: opening, received, out, transfer or adjustment

Read and write key

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

productstringrequired

Product name, code or id

variantstring

The variant, by name, code or id: needed when the product has variants. "not split" for stock not split by variant

kindstringrequired

What happened

One of opening received out transfer adjustment

warehousestring

Warehouse name or code (for a transfer, where it comes from). The default when left out

toWarehousestring

Transfer only: where it goes

toVariantstring

Transfer only: the variant stock not split by variant is moved onto

qtynumber

How many, above zero (not for an adjustment)

countTonumber

Adjustment: what is there now

changeBynumber

Adjustment: plus or minus this many

reasonstring

Why, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/warehouses

List warehouses

Read key

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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/warehouses

Create a warehouse

Read and write key

Adds a warehouse.

Body

namestringrequired

Its name, unique in the workspace

codestring

A short code, optional

citystring

Optional

statestring

Optional

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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_deal_products

Set deal products

Read and write key

Sets the products on a deal: products replaces the whole list (an empty list takes them all off).

Body

dealnumberrequired

Deal id

productsarray of objectrequired

The deal’s products, in order

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_record_products

Set record products

Read and write key

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

objectstringrequired

contacts, companies, or a workspace object by id, name or plural

idnumberrequired

Record id

productsarray of objectrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_product_usage

Get product usage

Read key

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

productstringrequired

Product 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_price_books

List price books

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_price_book

Create price book

Read and write key

Adds a price book.

Body

namestringrequired

Book name, e.g. Wholesale

ruleFieldstring

Company select field key the rule reads

ruleValuestring

The choice that picks this book

isDefaultboolean

Make 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_price_book

Update price book

Read and write key

Renames a price book, changes its company rule (send ruleField and ruleValue as null to remove it), or makes it the default.

Body

bookstringrequired

Price book name or id

namestring

New name

ruleFieldstring

Company select field key, or null for no rule

ruleValuestring

The choice, or null

isDefaultboolean

Make 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_price_book

Archive price book

Read and write keyPermanent

Archives a price book: no longer offered or matched, while its prices stay for the deal lines already quoted from it.

Body

bookstringrequired

Price 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_product_prices

Get product prices

Read key

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

productstringrequired

Product 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_product_variants

Set product variants

Read and write keyPermanent

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

productstringrequired

Product name, code or id

variantsarray of objectrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_product_price

Set product price

Read and write key

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

productstringrequired

Product name, code or id

variantstring

Variant name, code or id; leave out for a product without variants

bookstringrequired

Price book name or id

ratesobject

The 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.

clearboolean

Take 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/quote_price

Quote price

Read key

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

productstringrequired

Product name, code or id

variantstring

Variant name, code or id

bookstring

Price book name or id; the default book when left out

qtynumberrequired

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_deal_price_book

Set deal price book

Read and write key

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

dealnumberrequired

Deal id

bookstringrequired

Price book name or id

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/reprice_deal_products

Reprice deal products

Read and write key

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

dealnumberrequired

Deal id

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_stock

Get stock

Read key

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

productstringrequired

Product name, code or id

variantstring

Optional: one variant’s stock, by name, code or id ("not split" for stock not split by variant)

historyboolean

Also 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/record_stock

Record stock

Read and write key

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

productstringrequired

Product name, code or id

variantstring

The variant, by name, code or id: needed when the product has variants. "not split" for stock not split by variant

kindstringrequired

What happened

One of opening received out transfer adjustment

warehousestring

Warehouse name or code (for a transfer, where it comes from). The default when left out

toWarehousestring

Transfer only: where it goes

toVariantstring

Transfer only: the variant stock not split by variant is moved onto

qtynumber

How many, above zero (not for an adjustment)

countTonumber

Adjustment: what is there now

changeBynumber

Adjustment: plus or minus this many

reasonstring

Why, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Any object

GET/objects/{object}/records

List or search records of any object

Read key

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

objectstringrequired

The object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)

Query parameters

querystring

Words to match

ownerstring

Only records this member owns, by email or name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/objects/{object}/records

Create a record

Read and write key

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

objectstringrequired

The 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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/objects/{object}/records/{id}

Get a record

Read key

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

objectstringrequired

The object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/objects/{object}/records/{id}

Update a record

Read and write key

Changes a record of any object.

Path parameters

objectstringrequired

The object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/objects/{object}/records/{id}

Delete a record

Read and write key

Deletes a record of any object for good, with its notes and history.

Path parameters

objectstringrequired

The object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/objects/{object}/records/{id}/stage-times

The stages of a record: each stay with when it came in, when it left and for how long

Read key

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

objectstringrequired

The object: companies, deals, contacts, or a workspace object’s id (obj_…, from /schema)

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Tasks

GET/tasks

List what is to do (every kind by default), or other activities by type

Read key

Tasks, open ones by default: yours, everyone’s you can see, or those on one record.

Query parameters

scopestring

Tasks you created or are on (default), or all you can see

statusstring

Default open

typestring

Default: every kind of thing to do (all but notes). "task" is read as other

overdueboolean

Only those past due

dueBeforestring

Only those due before this ISO date

createdAfterstring

Only those made on or after this ISO date

createdBeforestring

Only those made before this ISO date

contactIdnumber

The contact it is about

companyIdnumber

The company it is about

dealIdnumber

The deal it is about

limitnumber

Default 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/tasks

Add a call, meeting, email, message or other to do, with an optional reminder

Read and write key

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

subjectstringrequired

What needs doing

duestring

Due date and time, ISO 8601, e.g. 2026-10-01T17:00:00+05:30. Left out: tomorrow at 9 AM

prioritystring

Default Medium

One of Low Medium High

assigneestring

Who owns it, by member email or name. Default: you

bodystring

Details

kindstring

What it is. Default other ("task" is read as other)

One of call meeting email message other task

reminderstring

When 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

parentTaskIdstring

Put it on the same records as this task

notifyarray of string

People to keep informed, by member email or name

contactIdnumber

The contact it is about

companyIdnumber

The company it is about

dealIdnumber

The deal it is about

recordsarray of object

Other 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"]
Response · 201
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/tasks/{id}

Get a task

Read key

One task (or any activity).

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/tasks/{id}

Update a task

Read and write key

Changes a task or activity.

Path parameters

idstringrequired

The record id

Body

subjectstring

New subject

bodystring

New details

duestring

New due date, ISO 8601 (tasks), or when it happened (other types)

prioritystring

One of Low Medium High

statusstring

One of planned done cancelled

assigneestring

New owner, by member email or name

notifyarray of string

The full new list of people to keep informed, by email or name

detailsobject

Type fields to change

reminderstring

When 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

moveIntoTaskstring

Put it on the same records as this task

contactIdnumber

The contact it is about. Passing any record replaces what it is linked to

companyIdnumber

The company it is about. Passing any record replaces what it is linked to

dealIdnumber

The deal it is about. Passing any record replaces what it is linked to

recordsarray of object

Other 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
DELETE/tasks/{id}

Delete a task

Read and write key

Deletes a task or activity for good.

Path parameters

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "deleted": true
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/tasks/{id}/complete

Mark it done, with an optional note on how it went

Read and write key

Marks it done.

Path parameters

idstringrequired

The record id

Body

notestring

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Meetings

GET/meetings

List meetings: by range, the key maker’s own or the team’s, internal or external, or still to follow up

Read key

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

qstring

Words that must all appear in the title or summary

fromstring

Only meetings starting on or after this date (YYYY-MM-DD or ISO time)

tostring

Only meetings starting on or before this date

scopestring

mine: meetings the person is in or brought in; team (default): every meeting they may see

internalboolean

true: only internal meetings (everyone on the team); false: only those with someone from outside

personnumber

Only meetings this member (user id, from list_members) is in

to_follow_upboolean

Only past external meetings with no email to their guests since, and each one’s last email date

prepboolean

Add 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/meetings/{id}

Get a meeting: guests and their answers, where it came from, internal, cancelled, the join link, summary and deal

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_meetings

List meetings

Read key

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

recordobject

Only the meetings on this record

qstring

Words that must all appear in the title or summary

fromstring

Only meetings starting on or after this date (YYYY-MM-DD or ISO time)

tostring

Only meetings starting on or before this date

scopestring

mine: meetings the person is in or brought in; team (default): every meeting they may see

One of mine team

mineboolean

The same as scope: mine

internalboolean

true: only internal meetings (everyone on the team); false: only those with someone from outside

personnumber

Only meetings this member (user id, from list_members) is in

to_follow_upboolean

Only past external meetings with no email to their guests since, and each one’s last email date

prepboolean

Add 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_meeting

Get meeting

Read key

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

idstringrequired

Meeting id, from list_meetings

transcriptboolean

Also 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_meeting_deal

Set meeting deal

Read and write key

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

idstringrequired

Meeting id, from list_meetings

dealnumber | stringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/draft_meeting_follow_up

Draft meeting follow-up

Read key

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

idstringrequired

Meeting id, from list_meetings

changestring

To refine a draft: what to change, in the person’s words

draftstring

To 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/send_meeting_follow_up

Send meeting follow-up

Read and write key

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

idstringrequired

Meeting id, from list_meetings

textstringrequired

The message, plain text

toarray of string

Email addresses to send to (default the people outside the team who were there)

ccarray of string

Cc addresses

bccarray of string

Bcc addresses

subjectstring

Subject (default “Following up: ” and the meeting’s title)

inboxstring

Which of the person’s inboxes to send from

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_notetakers

Get notetakers

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/check_notetaker_now

Check notetaker now

Read and write key

Asks the person’s own notetaker for new meetings now, as Check now in Settings › Notetakers does.

Body

notetakerstringrequired

granola, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_notetaker

Disconnect notetaker

Read and write keyPermanent

Disconnects the person’s own notetaker, as Disconnect in Settings › Notetakers does.

Body

notetakerstringrequired

granola, fireflies or fathom

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Members

GET/members

List members with their built-in fields and the member fields the key’s owner may see

Read key

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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/members/{id}

Get a member, their fields and the history of changes

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
PATCH/members/{id}

Set a member’s own fields by label, such as pay; null clears one

Read and write key

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

idstringrequired

The record id

Body

memberstringrequired

Member email, name or user id

valuesobjectrequired

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Schema

GET/schema

Get the workspace schema: objects, fields and their choices

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Connected apps

GET/connections

List connected apps and the tools that are on

Read key

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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
GET/connections/{connection}/tools

A connected app’s tools that are on: what each does, its inputs, reads or changes

Read key

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

connectionstringrequired

The 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"]
Response · 200
{
  "data": {
    "total": 1,
    "…": [
      {
        "id": 101,
        "…": "…"
      }
    ]
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/connections/{connection}/tools/{tool}/call

Call one switched-on tool of a connected app; its answer is outside data

Read and write key

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

connectionstringrequired

The connected app: its id (cn_…) or name, from /connections

toolstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_connections

List connected apps

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/test_connection

Test connected app

Read and write key

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

connectionstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/rename_connection

Rename connected app

Read and write key

Renames a connected app, as renaming it in Settings does.

Body

connectionstringrequired

The connected app: its id or name, from list_connections

namestringrequired

Its 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_connection

Disconnect connected app

Read and write keyPermanent

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

connectionstringrequired

The connected app: its id or name, from list_connections

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_app_tools

List an app’s tools

Read key

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

connectionstringrequired

The connected app: its id or name, from list_connections

toolstring

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/use_app_tool

Use an app’s tool

Read and write key

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

connectionstringrequired

The connected app: its id or name, from list_connections

toolstringrequired

The tool’s name, from list_app_tools

argumentsobject

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/switch_app_tools

Switch app tools on or off

Read and write key

Switches a connected app’s tools on or off, as the switches in Settings do: named tools, or all of them.

Body

connectionstringrequired

The connected app: its id or name, from list_connections

toolsarray of string

Tool names, from list_connections

allboolean

Every tool the app offers

onbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_app_tool_kind

Mark what an app tool does

Read and write key

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

connectionstringrequired

The connected app: its id or name, from list_connections

toolstringrequired

The tool’s name

kindstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/connect_app

Connect an app

Read and write key

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

addressstringrequired

The app’s MCP address, https://…

namestring

What 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_integrations

Get integrations

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Contacts and tasks

Actions
POST/actions/search_contacts

Search contacts

Read key

Finds contacts by name, email, phone, job title or company, optionally narrowed by status or owner.

Body

querystring

Words to match in the name, email, phone, job title or company names

statusstring

Only this lifecycle status

ownerstring

Only contacts this member owns, by email or name

companyIdnumber

Only contacts at this company

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_contact

Get contact

Read key

Everything about one contact: their fields, companies, owner, and their latest activities and open tasks.

Body

idnumberrequired

Contact 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_contact

Create contact

Read and write key

Adds a contact.

Body

firstNamestringrequired

First name

lastNamestring

Last name

emailstring

Email. A contact needs an email or a phone

phonestring

Phone, with country code

jobTitlestring

Job title

statusstring

Lifecycle status, one of the choices get_schema lists for contacts.status

sourcestring

Where they came from, one of the choices get_schema lists for contacts.source

linkedinstring

LinkedIn profile URL

telegramstring

Telegram username, like @priya

countrystring

Country they are based in, by name or two-letter code (India, IN)

statestring

Their state, province or region

citystring

Their city

ownerstring

Owner, by member email or name

companyIdsarray of number

Companies they work with, by id (replaces the current set)

companyNamestring

A company to link by exact name; made if the workspace has none by that name

customobject

Custom field values by field key (keys from get_schema)

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_contact

Update contact

Read and write key

Changes a contact.

Body

idnumberrequired

Contact id

firstNamestring

First name

lastNamestring

Last name

emailstring

Email. A contact needs an email or a phone

phonestring

Phone, with country code

jobTitlestring

Job title

statusstring

Lifecycle status, one of the choices get_schema lists for contacts.status

sourcestring

Where they came from, one of the choices get_schema lists for contacts.source

linkedinstring

LinkedIn profile URL

telegramstring

Telegram username, like @priya

countrystring

Country they are based in, by name or two-letter code (India, IN)

statestring

Their state, province or region

citystring

Their city

ownerstring

Owner, by member email or name

companyIdsarray of number

Companies they work with, by id (replaces the current set)

companyNamestring

A company to link by exact name; made if the workspace has none by that name

customobject

Custom field values by field key (keys from get_schema)

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_contact

Delete contact

Read and write keyPermanent

Deletes a contact for good, with their notes and history.

Body

idnumberrequired

Contact id

confirmbooleanrequired

True once the person has confirmed the delete

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_tasks

List tasks

Read key

Tasks, open ones by default: yours, everyone’s you can see, or those on one record.

Body

scopestring

Tasks you created or are on (default), or all you can see

One of mine all

statusstring

Default open

One of open done all

typestring

Default: every kind of thing to do (all but notes). "task" is read as other

One of call meeting email message other note any task

overdueboolean

Only those past due

dueBeforestring

Only those due before this ISO date

createdAfterstring

Only those made on or after this ISO date

createdBeforestring

Only those made before this ISO date

contactIdnumber

The contact it is about

companyIdnumber

The company it is about

dealIdnumber

The deal it is about

recordsarray of object

Other records it is about, as { object, id } (custom objects too)

limitnumber

Default 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_task

Get task

Read key

One task (or any activity).

Body

idstringrequired

Task 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_task

Create task

Read and write key

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

subjectstringrequired

What needs doing

duestring

Due date and time, ISO 8601, e.g. 2026-10-01T17:00:00+05:30. Left out: tomorrow at 9 AM

prioritystring

Default Medium

One of Low Medium High

assigneestring

Who owns it, by member email or name. Default: you

bodystring

Details

kindstring

What it is. Default other ("task" is read as other)

One of call meeting email message other task

reminderstring

When 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

parentTaskIdstring

Put it on the same records as this task

notifyarray of string

People to keep informed, by member email or name

contactIdnumber

The contact it is about

companyIdnumber

The company it is about

dealIdnumber

The deal it is about

recordsarray of object

Other 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/log_activity

Log activity

Read and write key

Logs a call, meeting, email, message or note on records, or on a task's records (taskId).

Body

typestringrequired

One of call meeting email message note

subjectstring

Short title

bodystring

What happened; required for a note

atstring

When, ISO 8601. Default now. A future time plans a meeting, call, email or message

durationMinutesnumber

How long, for calls and meetings

detailsobject

This type’s own fields (see the description)

taskIdstring

Log it on the same records as this task

notifyarray of string

People to keep informed, by member email or name

privateboolean

Notes on a record only: visible to you alone

contactIdnumber

The contact it is about

companyIdnumber

The company it is about

dealIdnumber

The deal it is about

recordsarray of object

Other 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_task

Update task

Read and write key

Changes a task or activity.

Body

idstringrequired

Task or activity id

subjectstring

New subject

bodystring

New details

duestring

New due date, ISO 8601 (tasks), or when it happened (other types)

prioritystring

One of Low Medium High

statusstring

One of planned done cancelled

assigneestring

New owner, by member email or name

notifyarray of string

The full new list of people to keep informed, by email or name

detailsobject

Type fields to change

reminderstring

When 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

moveIntoTaskstring

Put it on the same records as this task

contactIdnumber

The contact it is about. Passing any record replaces what it is linked to

companyIdnumber

The company it is about. Passing any record replaces what it is linked to

dealIdnumber

The deal it is about. Passing any record replaces what it is linked to

recordsarray of object

Other 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_notes

List notes

Read key

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

objectstringrequired

contacts, companies, deals or another object id from get_schema

idnumberrequired

Record id

limitnumber

At 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_note

Update note

Read and write key

Changes a note on a record (ids like note_…, from get_contact).

Body

idstringrequired

Note id

bodystring

The new text

privateboolean

Visible 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_note

Delete note

Read and write keyPermanent

Deletes a note on a record for good.

Body

idstringrequired

Note id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/complete_task

Complete task

Read and write key

Marks it done.

Body

idstringrequired

Task id

notestring

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/snooze_reminder

Snooze reminder

Read and write key

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

idstringrequired

Task id

untilstringrequired

laterToday, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/no_reply_needed

No reply needed

Read and write key

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

idstringrequired

Task 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_task

Delete task

Read and write keyPermanent

Deletes a task or activity for good.

Body

idstringrequired

Task or activity id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Records

Actions
POST/actions/search_records

Search records

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

querystring

Words to match

ownerstring

Only records this member owns, by email or name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_record

Get record

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

idnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_record

Create record

Read and write key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

fieldsobjectrequired

Field 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.

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_all_records

Read all records

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

columnsarray of string

Only these fields, by name (id and name always come)

nextnumber

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_record

Update record

Read and write key

Changes a record of any object.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

idnumberrequired

Record id

fieldsobjectrequired

Field 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.

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_deal_split

Set deal split

Read and write key

Shares credit on a deal between its owner and other members.

Body

dealnumberrequired

Deal id

membersarray of objectrequired

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_record

Delete record

Read and write keyPermanent

Deletes a record of any object for good, with its notes and history.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

idnumberrequired

Record id

confirmbooleanrequired

True once the person has confirmed the delete

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bulk_update_records

Bulk update records

Read and write key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

idsarray of numberrequired

Record ids, at most 200

fieldsobjectrequired

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bulk_delete_records

Bulk delete records

Read and write keyPermanent

Deletes many records of one object for good, with their notes and history, up to 200 ids per call.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural (get_schema lists them)

idsarray of numberrequired

Record ids, at most 200

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bulk_update_tasks

Bulk update tasks

Read and write key

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 stringrequired

Task ids, at most 200

actionstringrequired

complete marks them done; reassign needs assignee; due needs due

One of complete reassign due

assigneestring

For reassign: the new assignee, by member email or name

duestring

For 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bulk_delete_tasks

Bulk delete tasks

Read and write keyPermanent

Deletes many tasks or activities for good, up to 200 ids per call.

Body

idsarray of stringrequired

Task ids, at most 200

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/link_records

Link records

Read and write key

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

fromobjectrequired
toobjectrequired
rolestring

A contact’s or company’s role on a deal, e.g. Decision maker

relationshipstring

Which workspace relationship, by label or id, when several join the two

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/unlink_records

Unlink records

Read and write key

Removes a link between two records (the records themselves stay).

Body

fromobjectrequired
toobjectrequired
relationshipstring

Which workspace relationship, by label or id, when several join the two

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_deal_from_pipeline

Remove deal from pipeline

Read and write keyPermanent

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

idnumberrequired

Deal id

pipelinestringrequired

The pipeline to leave: its name or id

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Workspace settings

Actions
POST/actions/get_settings

Get settings

Read key

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

sectionstring

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_pipeline

Create pipeline

Read and write key

Adds a deal pipeline with its stages.

Body

namestringrequired

Pipeline name

descriptionstring

What it is for

stagesarray of objectrequired

The 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.

makeDefaultboolean

Make it the pipeline new deals land in

splitCreditboolean

Let 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_pipeline

Update pipeline

Read and write key

Renames a pipeline or changes its open stages.

Body

pipelinestringrequired

Pipeline name or id

namestring

New name

descriptionstring

New description

stagesarray of object

The 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.

splitCreditboolean

Let 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_default_pipeline

Set default pipeline

Read and write key

Makes a pipeline the one new deals land in.

Body

pipelinestringrequired

Pipeline 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_pipeline

Archive pipeline

Read and write key

Archives a pipeline (its deals and history stay; it can be restored) or restores one with archived: false.

Body

pipelinestringrequired

Pipeline name or id

archivedboolean

false 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_warehouses

List warehouses

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_warehouse

Create warehouse

Read and write key

Adds a warehouse.

Body

namestringrequired

Its name, unique in the workspace

codestring

A short code, optional

citystring

Optional

statestring

Optional

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_warehouse

Update warehouse

Read and write key

Renames or edits a warehouse (by name, code or id), and makeDefault: true makes it the default.

Body

warehousestringrequired

Warehouse name, code or id

namestring

New name

codestring

New code

citystring

City

statestring

State

makeDefaultboolean

true 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_warehouse

Archive warehouse

Read and write key

Archives a warehouse (its stock and history stay; it is no longer offered for new stock) or restores one with archived: false.

Body

warehousestringrequired

Warehouse name, code or id

archivedboolean

false 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_object

Create object

Read and write key

Adds an object of the workspace’s own (like Projects or Tickets), with a required Name field to start.

Body

namestringrequired

Singular, e.g. Project

pluralstringrequired

Plural, e.g. Projects

iconstring

One of box folder ticket calendar chart tag star flag

colorstring

gray, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_object

Update object

Read and write key

Renames a workspace object or changes its icon, colour, or which fields name and describe its records.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

namestring

Singular

pluralstring

Plural

iconstring

One of box folder ticket calendar chart tag star flag

colorstring

gray, blue, green, yellow, orange, red, purple

titleFieldstring

Field (label or id) that names a record

subtitleFieldstring

Field (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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_object

Archive object

Read and write key

Archives a workspace object (hidden, records kept, can be restored) or restores it with archived: false.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

archivedboolean

false 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_object

Delete object

Read and write keyPermanent

Deletes a workspace object for good, with its fields and views.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_field

Create field

Read and write key

Adds a custom field to any object, built in or the workspace’s own.

Body

objectstringrequired

contacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural

labelstringrequired

Field name, e.g. Contract value

typestring

One of text longText number currency percent date datetime checkbox singleSelect multiSelect email phone url country user file

optionsarray of string

Choices, for singleSelect and multiSelect

helpstring

A line of help under the field

requiredboolean

Every record must have it

uniqueboolean

No two records may share a value (text, email, phone, url, number, currency, date)

defaultValueany

What new records start with

magicstring

Makes 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.

visibilitystring

Member 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

formulastring

Member 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

filesobject
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_field

Update field

Read and write key

Changes a custom field’s label, help, required, unique or default.

Body

objectstringrequired

contacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural

fieldstringrequired

Field label or id

labelstring

New label

helpstring

Help line

requiredboolean

Required

uniqueboolean

Unique

defaultValueany

Default for new records

optionsarray of string

Full list of choices (only adding; use set_field_choices to rename or remove)

magicstring

A magic field’s new instructions; every record not set by hand is worked out again

visibilitystring

Member 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

formulastring

Member 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/preview_magic_field

Try magic instructions

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

typestringrequired

One of text longText number currency percent date datetime checkbox singleSelect multiSelect

instructionsstringrequired

Plain-language instructions; name fields in braces, like {Amount}

optionsarray of string

Choices, for singleSelect and multiSelect

labelstring

The field’s name

recordIdsarray of number

Up 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_magic_runs

Get magic runs

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

Field label or id

recordIdnumber

One record

filterstring

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/refresh_magic_field

Refresh magic field

Read and write key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

Field label or id

recordIdnumber

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/release_magic_value

Let magic fill again

Read and write key

“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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

Field label or id

recordIdnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/pause_magic_field

Pause magic field

Read and write key

Pauses a magic field (nothing runs; values stay) or resumes it (every record not set by hand catches up).

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

Field label or id

pausedbooleanrequired

true 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_field_choices

Set field choices

Read and write key

Sets the choices of a select field: a custom single or multi select, or a standard one (contacts: status, source, buyingRoles; companies: icp).

Body

objectstringrequired

contacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural

fieldstringrequired

Field label or id, or status / source / buyingRoles / icp

choicesarray of objectrequired

The full list, in order: strings, or { value, color (gray, blue, green, yellow, orange, red, purple) }

replacementsobject

Where records on an old choice go: { "Old": "New" or null }

defaultValuestring

Standard 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_field

Archive field

Read and write key

Archives a custom field (hidden, values kept, can be restored) or restores it with archived: false.

Body

objectstringrequired

contacts, companies, deals, products, members (the team: fields such as pay, each private by default), or a workspace object by id, name or plural

fieldstringrequired

Field label or id

archivedboolean

false to restore; default true

forceboolean

Archive 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/arrange_fields

Arrange fields

Read and write key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

orderarray of string

Fields in the order they should appear, first first

hidearray of string

Standard fields to hide

showarray of string

Hidden standard fields to show again

requirearray of string

Standard fields to make required

optionalarray of string

Standard 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_field

Delete field

Read and write keyPermanent

Deletes an archived custom field and every value it holds, permanently.

Body

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

Custom field label or id

confirmboolean

true 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_relationship

Create relationship

Read and write key

Joins two objects so their records can be linked, e.g.

Body

fromstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

tostringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fromLabelstringrequired

What a from record calls its linked to records, e.g. Projects

toLabelstringrequired

What a to record calls its linked from records, e.g. Account

manyToboolean

A from record may hold several to records (default true)

manyFromboolean

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_relationship

Update relationship

Read and write key

Renames a relationship’s labels or changes whether each side may hold several records.

Body

relationshipstringrequired

Relationship id or either label

fromLabelstring

New from label

toLabelstring

New to label

manyToboolean

manyTo

manyFromboolean

manyFrom

showReverseboolean

Show 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_relationship

Archive relationship

Read and write key

Archives a relationship (hidden, links kept, can be restored) or restores it with archived: false.

Body

relationshipstringrequired

Relationship id or either label

archivedboolean

false 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_relationship

Delete relationship

Read and write keyPermanent

Deletes a relationship for good.

Body

relationshipstringrequired

Relationship id or either label

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_workspace_settings

Update workspace settings

Read and write key

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

namestring

Workspace name

currencystring

ISO currency code

fiscalYearStartnumber

Month the fiscal year starts, 1-12

businessHoursobject

{ mode: 'calendar' | 'business', days: [1..5] (0 is Sunday), startMinute: 540, endMinute: 1080, timezone: 'Asia/Kolkata' }

targetsobject

Hours allowed per stage, keyed object.field.value

funnelarray of string

Contact statuses in funnel order

tracksobject

Which select field each object’s stage clock follows, e.g. { contacts: "status" }

maxFileMbnumber

The largest file anyone may upload, in MB: 1 to 25

storageMbnumber

All the workspace’s files together, in MB: 100 to 5120 (5 GB)

priceBookFromCompanyboolean

A new deal takes its company’s price book. Off: every deal starts on the default book

missingPricestring

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_stage_fields

Set stage fields

Read and write key

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

objectstringrequired

deals, contacts, or one of the workspace’s own objects (its id)

pipelinestring

Deals only: the pipeline’s name or id. Left out: the default pipeline.

stagestringrequired

The stage’s name (or a deal stage’s id)

fieldsarray of stringrequired

The fields this stage needs, by label or key. Empty clears it.

alsoEarlierboolean

Also 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_company_about

Get About the company

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_company_about

Update About the company

Read and write key

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

textstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/draft_company_about

Draft About the company

Read and write key

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

websitestring

The website to read, like acme.com. Left out: the one saved

replaceboolean

Replace 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/add_member

Add member

Read and write key

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

emailstringrequired

Their email or phone

namestring

Their name

rolestring

One of member admin

profilestring

A profile by name or id (members only)

notifyboolean

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/resend_invite

Resend invite

Read and write key

Emails someone who was added but hasn’t signed in yet their invite again.

Body

memberstringrequired

Member 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_member

Update member

Read and write key

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

memberstringrequired

Member email or name

rolestring

One of member admin

profilestring

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_members

List members

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_member

Get member

Read key

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

memberstringrequired

Member 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_member_details

Set member details

Read and write key

Sets a member’s own fields, such as base salary, variable pay or team: values by field label (or id); null clears one.

Body

memberstringrequired

Member email, name or user id

valuesobjectrequired

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_member

Remove member

Read and write keyPermanent

Removes someone from the workspace; the records they own stay.

Body

memberstringrequired

Member email or name

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_ai_settings

Update AI settings

Read and write key

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

duplicatesboolean

Detect duplicates

backfillSincestring

'all' or YYYY-MM-DD: check existing records too

magicboolean

AI magic fields may run

magicBudgetnumber

Monthly AI budget for magic fields, in dollars

intentboolean

AI reads records for High intent

winMeansstring

What counts as a win, in plain words; "" for a won deal

webSearchboolean

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_choice_usage

Get choice usage

Read key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/load_sample_data

Load sample data

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_sample_data

Remove sample data

Read and write keyPermanent

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

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Insights and history

Actions
POST/actions/find_duplicates

Find duplicates

Read and write key

Finds duplicate contacts or companies.

Body

objectstringrequired

contacts or companies

One of contacts companies

idnumber

One record to check

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/scan_duplicates

Scan for duplicates

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/dismiss_duplicate

Dismiss duplicate

Read and write key

Marks two records as not duplicates, so the pair stops being suggested.

Body

objectstringrequired

contacts or companies

One of contacts companies

anumberrequired

One record id

bnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/merge_preview

Merge preview

Read key

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

objectstringrequired

contacts or companies

One of contacts companies

keepnumberrequired

Id of the record that stays

removenumberrequired

Id 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/merge_records

Merge records

Read and write keyPermanent

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

objectstringrequired

contacts or companies

One of contacts companies

keepnumberrequired

Id of the record that stays

removenumberrequired

Id of the duplicate

choicesobject

Per field, from merge_preview: "existing" keeps the kept record’s value, "incoming" takes the duplicate’s, "both" keeps both companies

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/start_deep_analysis

Start a deep analysis

Read and write key

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

questionstringrequired

What the analysis should answer, in the person’s words

objectstring

Which object: deals (default), contacts, companies or a workspace object

confirmboolean

true 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_deep_analysis

Deep analysis

Read and write key

How far a deep analysis has got (records read of the total, cost so far), and its report link once written.

Body

idstringrequired

The analysis id start_deep_analysis gave

stopboolean

Stop 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/explain_record

Explain a record

Read key

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

objectstringrequired

Any object

idnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_history

Get history

Read key

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

objectstringrequired

Any object

idnumberrequired

Record id

limitnumber

How many, default 20, at most 100

beforestring

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_high_intent

Get high intent

Read key

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

objectstring

contacts, companies or deals; leave out for all three

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_high_intent_again

Read high intent again

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/learn_high_intent

Learn high intent

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_stage_times

Get stage times

Read key

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

objectstringrequired

Any object with a stage: deals, contacts, …

idnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_overdue

List overdue

Read key

Records that have sat in their stage past its target (overdue) or are close to it (due soon), longest over first.

Body

objectstring

Only this object (deals, contacts, …)

includestring

Default overdue

One of overdue dueSoon both

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_insights

Get insights

Read key

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

periodstring

Default month

One of day week month quarter year custom

yearnumber

Year

quarternumber

1-4

fromstring

custom: first day, YYYY-MM-DD

tostring

custom: last day, YYYY-MM-DD

pipelinestring

Pipeline name or id

filtersarray of object

Deal 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_spend

Get spend

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_spend

Set spend

Read and write key

Records what was spent on a lead source in a month (amount 0 means nothing was spent; null clears it back to unknown).

Body

sourcestringrequired

Lead source, as in contact sources

monthstringrequired

YYYY-MM

amountnumberrequired

Amount 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_views

List views

Read key

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

objectstring

The list: contacts, companies, deals, products, a workspace object, tasks, insights, or report

reportstring

For 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_card_fields

Set card fields

Read and write key

Sets what each card shows on a board, for the person this token belongs to (their own choice, not part of any view).

Body

objectstringrequired

Object whose board this is

fieldsarray of string

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/save_view

Save view

Read and write key

Saves a view of a list, or changes one (pass view: its name or id), the way the app's Views menu does.

Body

objectstring

The list: contacts, companies, deals, products, a workspace object, tasks, insights, or report

reportstring

For object report: the report’s name or id

viewstring

An existing view’s name or id, to change it

namestring

View name

filtersarray of object
sortobject

{ id: column, dir: asc | desc }, or null for the list’s own sort

columnsarray of string

Every column to show, in order; the rest are hidden

hiddenarray of string

Columns to hide (replaces the hidden set)

showarray of string

Columns to show on top of what shows now

orderarray of string

Columns to put first, in this order

periodobject | string

Insights and report views: { kind: week | month | quarter | year | custom, year?, quarter?, from?, to? }

pipelinestring

Insights 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

modestring

list or board: how the list opens with this view; null (or left out) leaves it to each person

groupBystring

Tasks views: how the board groups, dueBucket (Due), status, priority or assignee; null leaves it to each person

sharedboolean

Share with the workspace

makeDefaultboolean

Open 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_default_view

Set default view

Read and write key

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

objectstring

The list: contacts, companies, deals, products, a workspace object, tasks, insights, or report

reportstring

For object report: the report’s name or id

viewstringrequired

View 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_view

Delete view

Read and write keyPermanent

Deletes a saved view (the records it lists are untouched).

Body

viewstringrequired

View name or id

objectstring

Its list, when names repeat across lists

reportstring

For 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_report

Delete report

Read and write keyPermanent

Deletes a report for good (its author, or an owner or admin).

Body

reportstringrequired

Report id or name

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Email

Actions
POST/actions/list_email_conversations

List email conversations

Read key

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

mineboolean

Only conversations from the person’s own inboxes

qstring

Search subject, people and text

recordobject

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_email_conversation

Read email conversation

Read key

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

keystringrequired

Conversation 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/draft_email_reply

Draft email reply

Read key

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

keystringrequired

Conversation key

allboolean

Reply all rather than reply

changestring

To refine a draft: what to change, in the person’s words ("shorter", "mention the Friday deadline")

draftstring

To 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/send_email_reply

Send email reply

Read and write key

Sends a reply to an email conversation through the person’s own Gmail, threaded under it, and keeps it in the conversation.

Body

keystringrequired

Conversation key, from list_email_conversations or a reply task’s replyTo.conversation

textstringrequired

The message, plain text

allboolean

Reply all: everyone else on the thread too

toarray of string

Email addresses to send to (replaces the default)

ccarray of string

Cc addresses (replaces the default)

bccarray of string

Bcc addresses

subjectstring

Subject (default Re: the conversation’s)

inboxstring

Which of the person’s inboxes to send from (default the one it came through)

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_writing_profile

Get writing profile

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/relearn_writing_profile

Learn writing style again

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/add_writing_sample

Add writing sample

Read and write key

Teaches the person’s writing profile from an email they wrote, pasted whole (up to 5 kept).

Body

textstringrequired

An 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_email_signature

Set email signature

Read and write key

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

textstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_writing_sample

Remove writing sample

Read and write keyPermanent

Removes one of the emails the person pasted into their writing profile, by its index from get_writing_profile.

Body

indexnumberrequired

Index 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/forget_writing_profile

Forget writing profile

Read and write keyPermanent

Forgets what was learned about how the person writes, and the emails they pasted.

Body

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Gmail sync

Actions
POST/actions/get_gmail

Get Gmail

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_gmail_brought_in

List emails brought in

Read key

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

inboxstring

Inbox address or id (optional when there is one)

daysnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_gmail_status

Pause or resume Gmail

Read and write key

Pauses or resumes Gmail sync for one of the person’s inboxes.

Body

inboxstring

Inbox address or id (optional when there is one)

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/check_gmail_now

Check Gmail now

Read and write key

Reads new mail in one of the person’s inboxes now, rather than waiting for the next minute.

Body

inboxstring

Inbox 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_gmail

Disconnect Gmail

Read and write keyPermanent

Disconnects one of the person’s own inboxes; emails already brought in stay.

Body

inboxstring

Inbox address or id (optional when there is one)

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_team_inboxes

List team inboxes

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_team_inbox

Disconnect a member’s inbox

Read and write keyPermanent

Owners and admins: disconnects a member’s Gmail inbox, by its id from list_team_inboxes.

Body

idstringrequired

Inbox id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_email_review

List emails to review

Read key

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

inboxstring

Inbox address or id (optional: all of theirs)

hoursnumber

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_review_email

Read email to review

Read key

One email waiting in the person’s Review, in full, by its id from list_email_review.

Body

idstringrequired

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bring_in_review_emails

Bring emails into the CRM

Read and write key

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 stringrequired

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_skipped_emails

List skipped emails

Read key

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

inboxstring

Inbox address or id (optional: all of theirs)

reasonstring

Only this reason, in its words (optional)

hoursnumber

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_inbox_emails

List inbox emails

Read key

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

hoursnumber

How many hours back (default 24, at most 336)

landedstring

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_inbox_email

Read inbox email

Read key

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

idstringrequired

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_skipped_email

Read skipped email

Read key

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

idstringrequired

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/bring_in_skipped_emails

Bring skipped emails into the CRM

Read and write key

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 stringrequired

Email 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/dismiss_review_emails

Dismiss emails

Read and write keyPermanent

Dismisses emails from the person’s Review: they never come into the CRM and their copy is deleted.

Body

idsarray of stringrequired

Email ids

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Telegram

Actions
POST/actions/get_telegram

Get Telegram

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_telegram_filters

Set Telegram filters

Read and write key

The person’s own Telegram filters.

Body

onlySalesChatsboolean

Only sales chats come in

holdPrivateMessagesboolean

Private-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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_telegram_chats

List Telegram chats

Read key

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

mineboolean

Only the person’s own chats

qstring

Search

kindstring

One of private group

reviewboolean

Their chats waiting for them to track or ignore

ignoredboolean

Chats they ignored

recordobject

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_telegram_chat

Read Telegram chat

Read key

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

idstringrequired

Chat 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/reply_telegram_chat

Reply on Telegram

Read and write key

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

idstringrequired

Chat id

textstringrequired

The message

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_telegram_chat_status

Track or ignore a Telegram chat

Read and write key

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

idstringrequired

Chat id

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/link_telegram_chat

Link Telegram chat

Read and write key

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

idstringrequired

Chat id

objectstring

contacts, companies, deals, products, or a workspace object id

recordIdnumber

Record id

newContactobject

Make a contact and link it. person: who in the chat (their name, @username or tgUserId; optional in a 1:1 chat)

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/unlink_telegram_chat

Unlink Telegram chat

Read and write key

Takes a record off one of the person’s Telegram chats; its messages stop showing there.

Body

idstringrequired

Chat id

objectstringrequired

Record object

recordIdnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/settle_held_telegram_message

Bring in or dismiss a held message

Read and write keyPermanent

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

idstringrequired

Chat id

messageIdnumberrequired

Message id

bringbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_telegram_connections

List Telegram connections

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_member_telegram

Disconnect a member’s Telegram

Read and write keyPermanent

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

memberstringrequired

The member, by email or name

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_telegram_account_status

Pause or resume my Telegram account

Read and write key

Pauses or resumes the person’s own personal Telegram account in Crossing Edge, as Pause and Resume in Settings › Telegram do.

Body

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_telegram_bot

Disconnect the Telegram bot

Read and write keyPermanent

Owners and admins: disconnects the workspace’s Telegram bot, as Settings › Telegram does.

Body

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/clear_telegram_keys

Remove the Telegram app keys

Read and write keyPermanent

Owners and admins: removes the workspace’s Telegram app keys (my.telegram.org), as Settings › Telegram does.

Body

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/link_my_telegram

Link my Telegram

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_my_telegram

Disconnect my Telegram

Read and write keyPermanent

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

partstringrequired

linked: the bot link; personal: the personal account

One of linked personal

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Calendar

Actions
POST/actions/get_calendar_status

Get calendar status

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/find_meeting_time

Find meeting time

Read key

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

minutesnumber

How long the meeting is (default 30)

membersarray of number

Teammates, by user id from list_members

fromstring

Look from (ISO time; default now)

tostring

Look until (ISO time; default 7 days on)

startstring

A proposed start, to check for clashes

endstring

A proposed end

time_zonestring

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/book_meeting

Book meeting

Read and write key

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

titlestringrequired

What the meeting is called

startstringrequired

When it starts: an ISO time with its offset (2026-11-04T10:00:00+05:30), or a date (YYYY-MM-DD) for all day

endstring

When it ends (or the day after the last day, for all day); default start plus minutes

minutesnumber

How long, when no end is given (default 30)

all_dayboolean

A whole-day event

time_zonestring

The IANA zone the times are meant in (repeats follow it); default the person’s own

guestsarray of string

Guest email addresses: contacts (find them with search_contacts) or anyone

membersarray of number

Teammates to invite, by user id from list_members

meetboolean

Add a Google Meet link (default true)

locationstring

Where

agendastring

The agenda or description guests see

recordsarray of object

Records it goes on besides its guests’ contacts: the deal, company or contacts it is about

repeatstring

Repeats (default never)

One of never daily weekly weekdays monthly

repeat_daysarray of number

For weekly: the days, 0 is Sunday

reminder_minutesnumber

A reminder this many minutes before; null for Google’s default

privateboolean

Private on the calendar: others see only Busy

show_asstring

Shown as busy (default) or free

One of busy free

send_invitesboolean

Google emails the guests (default true)

inboxstring

Which Google inbox’s calendar (mailboxId from get_calendar_status)

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_meeting

Update meeting

Read and write key

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

idstringrequired

Meeting id, from list_meetings

titlestring

What the meeting is called

startstring

When it starts: an ISO time with its offset (2026-11-04T10:00:00+05:30), or a date (YYYY-MM-DD) for all day

endstring

When it ends (or the day after the last day, for all day); default start plus minutes

minutesnumber

How long, when no end is given (default 30)

all_dayboolean

A whole-day event

time_zonestring

The IANA zone the times are meant in (repeats follow it); default the person’s own

guestsarray of string

Guest email addresses: contacts (find them with search_contacts) or anyone

membersarray of number

Teammates to invite, by user id from list_members

meetboolean

Add a Google Meet link (default true)

locationstring

Where

agendastring

The agenda or description guests see

recordsarray of object

Records it goes on besides its guests’ contacts: the deal, company or contacts it is about

repeatstring

Repeats (default never)

One of never daily weekly weekdays monthly

repeat_daysarray of number

For weekly: the days, 0 is Sunday

reminder_minutesnumber

A reminder this many minutes before; null for Google’s default

privateboolean

Private on the calendar: others see only Busy

show_asstring

Shown as busy (default) or free

One of busy free

notifyboolean

Google emails the guests the change (default true)

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/cancel_meeting

Cancel meeting

Read and write keyPermanent

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

idstringrequired

Meeting id, from list_meetings

notifyboolean

Google emails the guests (default true)

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/answer_meeting

Answer meeting

Read and write key

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

idstringrequired

Meeting id, from list_meetings

answerstringrequired

One of going maybe not_going

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Webhooks

Actions
POST/actions/list_webhooks

List webhooks

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_webhook_log

Get webhook log

Read key

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

webhookstring

Webhook name or id (optional when there is one)

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_webhook_status

Pause or resume a webhook

Read and write key

Pauses a webhook (leads wait in its log) or turns it back on (the waiting ones go in).

Body

webhookstring

Webhook name or id

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_webhook

Create webhook

Read and write key

Makes a new webhook: an address a form or tool posts leads to.

Body

namestringrequired

Where 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/map_webhook

Map and turn on a webhook

Read and write key

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

webhookstringrequired

Webhook name or id

fieldsobject

Payload 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 object

Values every lead gets. Defaults to the source set to the webhook’s name.

onExistingstring

A contact already in the CRM (same email or phone): fill its blanks (default), overwrite, or leave it

One of fill overwrite skip

companyFromDomainboolean

Find or add the company from a work email (default true; free mail never makes one)

namestring

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/preview_webhook

Preview a webhook lead

Read key

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

webhookstring

Webhook 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/run_webhook_post_again

Run a webhook post again

Read and write key

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

webhookstring

Webhook name or id

poststringrequired

Post 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/new_webhook_address

New webhook address

Read and write keyPermanent

Gives a webhook a new address; the old one stops working at once, so the tool must be given the new one.

Body

webhookstring

Webhook name or id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_webhook

Delete webhook

Read and write keyPermanent

Deletes a webhook: its address stops working and its log goes.

Body

webhookstringrequired

Webhook name or id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Outgoing webhooks

Actions
POST/actions/list_webhook_events

List webhook events

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_outgoing_webhooks

List sending webhooks

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_outgoing_webhook

Make sending webhook

Read and write key

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

namestringrequired

What it is for, e.g. "Won deals to Slack"

urlstringrequired

The https address to send to

eventsarray of stringrequired

Events to send (list_webhook_events)

objectsarray of string

Only these kinds of record (contacts, companies, deals, products, or a workspace object’s id or name from get_schema); leave out for every kind

conditionsobject

Optional, 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.

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_outgoing_webhook

Change sending webhook

Read and write key

Changes a sending webhook’s name, address, events or conditions.

Body

webhookstringrequired

Sending webhook name or id

namestring

New name

urlstring

New https address

eventsarray of string

Events to send (list_webhook_events)

objectsarray of string

Only these kinds of record (contacts, companies, deals, products, or a workspace object’s id or name from get_schema); leave out for every kind

conditionsobject

Optional, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_outgoing_webhook_status

Pause or resume sending webhook

Read and write key

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

webhookstring

Sending webhook name or id

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/test_outgoing_webhook

Test sending webhook

Read and write key

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

webhookstring

Sending webhook name or id

eventstring

Which 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_outgoing_webhook_log

Get sending webhook log

Read key

A sending webhook’s recent sends, newest first: event, when, whether it got through, the reply, tries so far and the next try.

Body

webhookstring

Sending 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/resend_webhook_delivery

Send again

Read and write key

Sends one logged send again within the minute, its tries counted from zero (get_outgoing_webhook_log for its id).

Body

deliverystringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/new_outgoing_webhook_secret

New signing secret

Read and write keyPermanent

Makes a new signing secret for a sending webhook.

Body

webhookstringrequired

Sending webhook name or id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_outgoing_webhook

Delete sending webhook

Read and write keyPermanent

Deletes a sending webhook and its log; nothing more is sent to its address.

Body

webhookstringrequired

Sending webhook name or id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

IndiaMART

Actions
POST/actions/get_indiamart

Get IndiaMART

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_indiamart_enquiries

List IndiaMART enquiries

Read key

The latest IndiaMART enquiries and what each became: a new lead, updated, already in the CRM, failed (with why) or waiting.

Body

limitnumber

How many (default 20, up to 200)

resultstring

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/connect_indiamart

Connect IndiaMART

Read and write key

Connects IndiaMART, or replaces its CRM key.

Body

keystring

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_indiamart

Update IndiaMART

Read and write key

Changes what IndiaMART enquiries become and who gets them, and switches a new connection on.

Body

mapobject

IndiaMART field → target

everyLeadGetsarray of object

Values every lead gets

ownersobject

Who gets each lead

dealobject

{ on, pipelineId, stage }

callTaskobject

{ on, dueMinutes }

existingRecordsstring

One of fill overwrite skip

agentsboolean

Run agents on each lead

pastDaysnumber

7, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_indiamart_status

Pause or resume IndiaMART

Read and write key

Pauses IndiaMART (enquiries sent by webhook are held and come in on resume) or resumes it.

Body

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/check_indiamart_now

Check IndiaMART now

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/retry_indiamart_enquiry

Retry IndiaMART enquiry

Read and write key

Takes a failed or waiting IndiaMART enquiry again, by its id from list_indiamart_enquiries.

Body

idstringrequired

Enquiry 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/new_indiamart_webhook

New IndiaMART webhook address

Read and write keyPermanent

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

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_indiamart

Disconnect IndiaMART

Read and write keyPermanent

Disconnects IndiaMART: the key, mapping, owners and enquiry log go; leads already made stay.

Body

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Events

Actions
POST/actions/list_events

List events

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_event

Get event

Read key

One event and everyone captured at it: who, who captured them, how (QR, card photo or typed) and when, newest first.

Body

eventstringrequired

Event 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_event

Create event

Read and write key

Starts an event in event mode and returns its capture-page link (open it on a phone to scan QR codes and cards).

Body

namestringrequired

Event name, e.g. TOKEN2049

sourcestring

Lead source captures start on

addSourceboolean

Add 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/end_event

End event

Read and write key

Ends an event so its link stops capturing, or reopens it with reopen: true.

Body

eventstringrequired

Event name or id

reopenboolean

Reopen 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/capture_at_event

Capture at event

Read and write key

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

eventstringrequired

Event name or id

contactIdnumber

An existing contact, instead of new details

firstNamestring

First name

lastNamestring

Last name

emailstring

Email

phonestring

Phone

jobTitlestring

Job title

companyIdnumber

Their company, if already in the CRM

telegramstring

Telegram handle, without the @

xstring

X (Twitter) handle, without the @

linkedinstring

LinkedIn profile URL

notestring

Anything else worth keeping, added to the note

methodstring

How they were captured; default typed

One of qr photo typed

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Exports

Actions
POST/actions/export_records

Export records

Read key

Exports records as a spreadsheet and returns a download link (kept 7 days).

Body

objectsarray of objectrequired

What 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_exports

List exports

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Agents

Actions
POST/actions/list_agents

List agents

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/make_agent

Make agent

Read and write key

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

wordsstringrequired

The job in the person’s own words, with any answer to an earlier question added

sendModestring

Only 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.

saveboolean

true to save the plan once the person has seen it and is happy

planobject

With 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/change_agent

Change agent

Read and write key

Changes an agent by plain words ("only for leads from India").

Body

agentstringrequired

The agent’s id or name

changestringrequired

What to change, in plain words

sendModestring

Only 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.

saveboolean

true to save the changed plan once the person has seen it

planobject

With 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/try_agent

Try agent

Read key

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

agentstringrequired

The agent’s id or name

countnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/pause_agent

Pause or resume agent

Read and write key

Pauses an agent, or resumes it with paused: false.

Body

agentstringrequired

The agent’s id or name

pausedboolean

true 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_agent_runs

Agent runs

Read key

An agent’s runs, newest first, a page at a time: when, why, which record, what each step did, the cost.

Body

agentstringrequired

The agent’s id or name

filterstring

One of errors drafts skipped

beforestring

The next value from the previous page

limitnumber

Runs 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/ask_agent

Ask agent

Read key

Asks one agent a question, such as “what did it do today?” or “why is it paused?”.

Body

agentstringrequired

The agent’s id or name

questionstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_agent

Delete agent

Read and write keyPermanent

Deletes an agent and its run log for good.

Body

agentstringrequired

The agent’s id or name

confirmboolean

Must 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Documents

Actions
POST/actions/list_files

List files

Read key

Files in Documents, as far as the person can see them.

Body

recordobject

Only the files on this record

folderstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

tagstring

Only files with this tag

qstring

Words that must all be in the file’s name

limitnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_file

Read file

Read key

Reads a text file (plain text, CSV, JSON, Markdown and the like) the person can see, on a record or in the Library.

Body

idstringrequired

File 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/attach_file

Attach file

Read and write key

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

namestring

File name with its extension, e.g. "Quote.pdf". Default: the link’s own name

urlstring

A public https link to the file

base64string

The file itself, base64 encoded (instead of url)

textstring

The 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

typestring

Its type, e.g. application/pdf. Default: what the link says, else from the name

recordobject

The record it goes on

folderstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

onlyMeboolean

Record files only: just the person (and owners and admins) can see it

forNewstring

Instead 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

fieldstring

Record 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

approvalobject

When 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_file

Update file

Read and write key

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

idstringrequired

File id, from list_files

namestring

New name, with its extension

textstring

A text file only: its whole new content

tagsarray of string

Its tags from now on, by name

onlyMeboolean

Record files: only the person, owners and admins see it

folderstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

shareany

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_files

Update files

Read and write key

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 stringrequired

File ids, from list_files

folderstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

addTagsarray of string

Tags to add, by name (a new name makes the tag)

removeTagsarray of string

Tags 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_files

Remove files

Read and write keyPermanent

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 stringrequired

File 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/link_document

Link document to record

Read and write key

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

idstringrequired

Library document id, from list_files

recordobjectrequired
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/unlink_document

Unlink document from record

Read and write key

Takes a Library document off a record.

Body

idstringrequired

Library document id

recordobjectrequired
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_folder

Create folder

Read and write key

A new Library folder, at the top or inside another.

Body

namestringrequired

Folder name

parentstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

shareany

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_folder

Update folder

Read and write key

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

folderstringrequired

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

namestring

New name

parentstring

A Library folder: its id (fd_…), its name, or "root" for the top of the Library

shareany

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_folder

Delete folder

Read and write keyPermanent

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

folderstringrequired

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_tag

Create tag

Read and write key

A new tag for files.

Body

namestringrequired

Tag name

colorstring

Its 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_tag

Update tag

Read and write key

Renames or recolours a tag, everywhere it is used.

Body

tagstringrequired

The tag, by name or id

namestring

New name

colorstring

New 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_tag

Delete tag

Read and write keyPermanent

Deletes a tag for good and takes it off every file.

Body

tagstringrequired

The tag, by name or id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_deleted_files

List deleted files

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/restore_deleted

Restore deleted

Read and write key

Puts a file or folder from Recently deleted back where it was (a folder with everything deleted with it).

Body

idstringrequired

File 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Imports

Actions
POST/actions/preview_paste_import

Preview paste import

Read key

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

textstringrequired

What was pasted: a table copied from a spreadsheet, CSV text, or leads as messages, emails or a typed list

columnsobject

Change 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

pipelinesobject

For a pipeline the sheet names that is not one: { "<name in the sheet>": "<an existing pipeline>" | "new" }

linksobject

For a workspace object with more than one way to link: { "<object>": "<relationship id>" | "none" }

fillobject

A value for a required field, used only on the rows that leave it empty: { "<field>": "<value>" }

pipelinestring

Where deals go when the sheet names no pipeline (default: the default pipeline)

setarray of object

Values 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

valueMapobject

What 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

onExistingstring

For 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/paste_import

Paste import

Read and write key

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

textstringrequired

What was pasted: a table copied from a spreadsheet, CSV text, or leads as messages, emails or a typed list

columnsobject

Change 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

pipelinesobject

For a pipeline the sheet names that is not one: { "<name in the sheet>": "<an existing pipeline>" | "new" }

linksobject

For a workspace object with more than one way to link: { "<object>": "<relationship id>" | "none" }

fillobject

A value for a required field, used only on the rows that leave it empty: { "<field>": "<value>" }

pipelinestring

Where deals go when the sheet names no pipeline (default: the default pipeline)

setarray of object

Values 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

valueMapobject

What 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

onExistingstring

For a record already here: fill its empty fields (default), overwrite them, or skip the row

One of fill overwrite skip

agentsboolean

Run 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_imports

List imports

Read key

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

idstring

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/fix_import_row

Fix import row

Read and write key

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

idstringrequired

Import id

rownumberrequired

Row number, as list_imports shows it

cellsobject

Corrected cells: { "<column>": "<value>" }; the rest stay as they were

valuesobject

Values 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/undo_import

Undo import

Read and write keyPermanent

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

idstringrequired

Import id

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

My preferences

Actions
POST/actions/get_my_preferences

Get my preferences

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_my_preferences

Set my preferences

Read and write key

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

reminderEmailsboolean

Email me my task reminders

agentEmailsboolean

Agents may email me

stopAgentEmailsstring

Stop one agent’s emails to me: its name or id

resumeAgentEmailsstring

Start one agent’s emails to me again: its name or id

desktopAlertsboolean

Show agent alerts as desktop notifications too

desktopRemindersboolean

Show my task reminders as desktop notifications too

replyTasksboolean

Open a task when a customer waits on my reply

namestring

My 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

API keys and AI tools

Actions
POST/actions/list_mcp_connections

List connected AI tools

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_mcp_connection

Disconnect an AI tool

Read and write keyPermanent

Disconnects one of the person’s connected AI tools, as Disconnect in Settings › MCP does: it stops reaching the workspace at once.

Body

connectionstringrequired

The AI tool: its id or name, from list_mcp_connections

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_api_keys

List API keys

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_api_key_activity

Get API key activity

Read key

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

keystringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/revoke_api_key

Revoke an API key

Read and write keyPermanent

Revokes an API key, as Revoke in Settings › API does: it stops working at once, for good, and whatever uses it stops too.

Body

keystringrequired

The key: its id, name or the start of it, from list_api_keys

confirmboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Quotas and targets

Actions
POST/actions/get_target_types

Get target types

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_target_type

Set target type

Read and write key

Makes a target type, or changes one (by its name or id in type).

Body

typestring

To change one: its name or id. Leave out to make a new one

namestring

Its name, like Meetings booked

ruleobject

What 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/archive_target_type

Archive target type

Read and write key

Archives a target type (or brings one back with restore: true).

Body

typestringrequired

Its name or id

restoreboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_quotas

Get quotas

Read key

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

typestring

Target 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_quota

Set quota

Read and write keyPermanent

Sets one member’s quota.

Body

memberstringrequired

Member email, name or user id

typestring

Target type, by name or id (see get_target_types). Default: Revenue won

countsany

What 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 objectrequired

All the member’s quota periods

rampsarray of object

All 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_quota_progress

Get quota progress

Read key

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

viewstring

month (default), quarter or year

atstring

A month inside the period, YYYY-MM (default: this month)

typestring

Target type, by name or id (see get_target_types). Default: Revenue won

peoplearray of string | integer

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Slack

Actions
POST/actions/get_slack

Get Slack

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/match_slack_member

Match a Slack member

Read and write key

Says which Slack person a member is, when their emails differ.

Body

memberstringrequired

The member: name, email or id

slackUserIdstring

Their Slack user id, like U01ABCDE

slackEmailstring

Their email address in Slack

noneboolean

True when this member has no Slack account

autoboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/disconnect_slack

Disconnect Slack

Read and write keyPermanent

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

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Approvals

Actions
POST/actions/get_org_chart

Get org chart

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_reports_to

Set reports to

Read and write key

Sets who a member reports to (their manager), or nobody.

Body

memberstringrequired

The member: email, name or user id

reportsTostringrequired

Their 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_approval_rules

List approval rules

Read key

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

objectstring

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_approval_rule

Get approval rule

Read key

One approval rule by its name or id, with its sentence and every part (trigger, conditions, form, steps, no answer, AI switches).

Body

rulestringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/save_approval_rule

Save approval rule

Read and write key

Makes an approval rule, or changes one (name or id in rule; what you leave out stays as it was).

Body

rulestring

To change one: its name or id. Leave out to make a new one

namestring

A short name, like Big discounts

objectstring

contacts, companies, deals, products or a custom object id

triggerobject

When it asks: a field changes, the record reaches a stage, or the record is deleted

conditionsarray of object

Only when other fields hold these

formarray of object

What the requester is asked

stepsarray of object

Who approves, in order

noAnswerobject

Hours until a reminder, passing it up, and lapsing

aiobject

The AI switches

enabledboolean

False keeps it but holds nothing

positionnumber

Its 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/turn_off_approval_rule

Turn off approval rule

Read and write key

Turns an approval rule off (or back on with on: true).

Body

rulestringrequired

The rule’s name or id

onboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/try_approval_rule

Try approval rule

Read key

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

rulestring

A saved rule’s name or id

draftobject

Or a rule not saved yet, shaped as save_approval_rule takes it

recordstringrequired

The record’s id

changesobject

What would change, field (label or key) to value, like {"Discount": 22}. Not needed for a delete rule

asstring

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_approvals

List approvals

Read key

With object and record: every approval on that record, open ones (waiting on whom) and past ones (approved, rejected, taken back, lapsed).

Body

tabstring

waiting_for_me, sent_by_me, done or all

groupstring

Only the requests of one import or bulk edit (its group id)

nextstring

The next value a previous page gave

objectstring

With record: the record’s object (contacts, companies, deals, products or a custom object id)

recordstring

Every 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_approval

Get approval

Read key

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

idstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/ask_for_approval

Ask for approval

Read and write key

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

objectstring

contacts, companies, deals, products or a workspace object

recordstring

The record’s id

rulestring

An approval rule’s name or id

approverstring

Or the member to ask: email, name or id

whatstring

What it is for, when asking a member

whystring

Why you are asking (the form’s Why?)

answersobject

Answers to the rule’s other form questions, by key

requeststring

To ask again after a send back: the request id

changesobject

Asking 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/answer_approval

Answer approval

Read and write key

Answers an approval request as this person: approve, send_back (change it and ask again) or reject.

Body

idstring

The request id

groupstring

Or a group id from list_approvals, to answer all of it

answerstringrequired

approve, send_back or reject

notestring

Why: needed to send back or reject

forstring

An 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/withdraw_approval

Withdraw approval

Read and write key

Takes back an approval request that is waiting or was sent back: nothing changes and the field it held is free again.

Body

idstringrequired

The request id

notestring

Why, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_approval_insights

Get approval insights

Read key

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

daysnumber

How 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Queues

Actions
POST/actions/list_queues

List queues

Read key

The workspace’s queues: each one puts the cards waiting in a stage in a fair line, so only the front may move.

Body

objectstring

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_queue

Get queue

Read key

One queue by name or id.

Body

queuestringrequired

The queue’s name or id

stagestring

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/save_queue_rule

Save queue rule

Read and write key

Makes a queue, or changes one (name or id in queue; what you leave out stays as it was).

Body

queuestring

To change one: its name or id. Leave out to make a new one

namestring

A short name, like Printing line

objectstring

contacts, companies, deals, products or a custom object id

stagesarray of string

The stages that are each a line

filterarray of object

Only cards matching these are in the queue

orderarray of object

What puts a card first

lanesobject

Split the line into lanes

frontnumber

Open cards at the front of each lane

locksarray of string

What a lock stops besides moving

gatesarray of object

What a card at the front waits for

skipBlockedboolean

A gated card at the front lets the next one go ahead

overridesobject

Who may skip the line

claimobject

Taking an open card holds it

ageingobject

Waiting cards move up

windowobject

When the line is open

batchesarray of object

Release some cards at set times

alertsarray of object

Stuck or reached the front

enabledboolean

False 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/pause_queue

Pause queue

Read and write key

Pauses a queue (or turns it back on with on: true).

Body

queuestringrequired

The queue’s name or id

onboolean

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/try_queue_rule

Try queue rule

Read key

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

queuestring

A saved queue’s name or id

draftobject

Or a queue not saved yet, shaped as save_queue_rule takes it

recordsarray of string

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/claim_card

Claim card

Read and write key

Takes an open card in a queue, so nobody else starts it.

Body

queuestringrequired

The queue’s name or id

recordnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/release_card

Release card

Read and write key

Lets go of a card you hold, so it is open to the line again.

Body

queuestringrequired

The queue’s name or id

recordnumberrequired

The card’s id

reasonstring

Why, 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/skip_line

Skip the line

Read and write key

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

queuestringrequired

The queue’s name or id

recordnumberrequired

The card’s id

tostringrequired

The stage to move it to (a deal’s stage name, or a choice of the stage field)

reasonstringrequired

Why 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Customer portal

Actions
POST/actions/get_portal

Get the portal

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/portal_guide

Portal guide

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_portal_page

Read a portal page

Read key

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

pagestring

The page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order

sharedstring

Instead of a page: the shared stylesheet (css) or script (js)

One of css js

fromnumber

Where 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/write_portal_page

Write a portal page

Read and write key

Writes a whole page of the portal’s design, new or replacing one, following portal_guide.

Body

pagestringrequired

The page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order

htmlstringrequired

The page’s HTML, with its own <style> and <script>

titlestring

Its 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/edit_portal_page

Edit a portal page

Read and write key

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

pagestringrequired

The page’s name, its address in the portal: lowercase letters, numbers and dashes, like orders or one-order

stepsarray of object

The changes, in order, up to 50

titlestring

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_portal_page

Delete a portal page

Read and write keyPermanent

Takes a page out of the portal’s design; the navigation, routes and home stop pointing at it.

Body

pagestringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_portal_shared

Set the portal’s shared parts

Read and write key

Changes the parts every page of the portal shares: the stylesheet (css), the script (js), the navigation (nav), the look (theme: mode, accent, font; null follows the portal’s settings), routes (for a tab’s key, the page that lists it and the page for one record; null removes one) and the home page.

Body

cssstring

The whole shared stylesheet

jsstring

The whole shared script

navarray of object

The navigation, in order, up to 12

themeobject
routesobject

By tab key: { list, record } page names, or null to remove one

homestring

The page customers land on

curl -X POST "https://api.crossingedge.com/v1/actions/set_portal_shared" \
  -H "Authorization: Bearer $CROSSING_EDGE_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "css": "…",
  "js": "…"
}'
const res = await fetch("https://api.crossingedge.com/v1/actions/set_portal_shared", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CROSSING_EDGE_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "css": "…",
    "js": "…"
  }),
});
const { data, error } = await res.json();
import os, uuid, requests

res = requests.post(
    "https://api.crossingedge.com/v1/actions/set_portal_shared",
    headers={"Authorization": f"Bearer {os.environ['CROSSING_EDGE_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
      "css": "…",
      "js": "…"
    },
)
data = res.json()["data"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/undo_portal_design

Undo a portal design change

Read and write key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_portal

Change the portal

Read and write key

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

namestring

The portal’s name, up to 60 characters

slugstring

Its address: portal.crossingedge.com/<slug>, lowercase letters, numbers and dashes

welcomestring

The line on the sign-in page, up to 160 characters

accentstring

Its colour, like #1f3a5f

themestring

One of light dark

statusstring

draft: 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

audiencestring

invited: only contacts invited; any: any contact with a company

One of invited any

signInarray of string

How codes go out. Email is always on; WhatsApp needs a connected number

askobject
contactPersonstring

Who 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_portal_data

Set what customers see

Read and write key

Sets what customers see: adds a tab (leave tab out; give label, object and fields) or changes one (tab, then only what changes).

Body

tabstring

The tab, by its key, label or id (get_portal lists them)

labelstring

The tab’s name, up to 40 characters

objectstring

For a new tab: its object

keystring

What pages ask for it by, like orders. Default: from the label

fieldsarray of string

Every field the tab shows, in order, by key or label

scopestring

One of company own

filterarray of object

Only records matching all of these. A choice field: { key, values }. A number or date: { key, min, max }. Text: { key, text }

verbsarray of string

view is always on; download lets them download its files

stageNamesobject

Names 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_portal_data

Stop showing a tab

Read and write keyPermanent

Takes a tab out of the portal: customers stop seeing it at once.

Body

tabstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/invite_to_portal

Invite to the portal

Read and write key

Invites a contact to the portal: they may sign in from now on (a removal is lifted).

Body

contactIdnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/remove_portal_access

Remove portal access

Read and write keyPermanent

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

contactIdnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/publish_portal

Publish the portal

Read and write key

Publishes the portal’s draft design: customers see it at once, and it is kept as a new version.

Body

notestring

What 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/restore_portal_version

Restore a portal version

Read and write key

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

versionnumberrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}

Reports and schema

Actions
POST/actions/report_guide

Report guide

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_schema

Get schema

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/run_query

Run query

Read key

Runs one report query and returns the answer, exactly as a report would get it.

Body

queryobjectrequired

A 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_reports

List reports

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_report

Get report

Read key

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

idstringrequired

Report 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/check_report

Check report

Read key

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

specobjectrequired

The report spec (see report_guide)

periodobject

{ kind: week | month | quarter | year | custom, year?, quarter?, from?, to? }. Default: the spec’s, else this month

pipelinestring

A pipeline name, as the pipeline picker would set it

filtersarray of object

Filter 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_report

Create report

Read and write key

Publishes a new report into Crossing Edge.

Body

namestringrequired

Short title, e.g. "Pipeline health"

descriptionstring

One line on what it answers

specobject

A native report spec (see report_guide). Check it with check_report first

htmlstring

Instead of a spec: the complete, self-contained HTML page

markdownstring

Instead 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

embedstring

Instead 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.

snapshotAtstring

For 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

sharedboolean

Show 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_report

Update report

Read and write key

Changes a report: any of its name, description, spec, HTML, markdown, embed, snapshotAt or sharing.

Body

idstringrequired

Report id

namestring

New title

descriptionstring

New description

specobject

The complete new spec

htmlstring

The complete new HTML

markdownstring

The complete new markdown (see create_report)

embedstring

Instead 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.

snapshotAtstring

For 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 object

Changes 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

sharedboolean
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_access_fields

Person fields that give access

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_access_fields

Set the person fields that give access

Read and write key

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

objectstringrequired

contacts, companies, deals, products, or a workspace object by id, name or plural

fieldsarray of objectrequired
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_profiles

List profiles

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/create_profile

Make a profile

Read and write key

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

namestringrequired

Profile name, e.g. Sales manager

permissionsanyrequired

Preset name, a profile to copy, or a permissions object

membersarray of string
curl -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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/update_profile

Change a profile

Read and write key

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

profilestringrequired

Profile name or id

namestring

New name

permissionsany

Preset name, a profile to copy, or a permissions object

isDefaultboolean

Make 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/delete_profile

Remove a profile

Read and write keyPermanent

Owners and admins: removes a profile.

Body

profilestringrequired

Profile 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_whatsapp

Get WhatsApp

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_whatsapp_chats

List WhatsApp chats

Read key

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

mineboolean

Only the person’s own chats

reviewboolean

Their chats waiting for them to bring in or ignore

qstring

Search

recordobject

Only 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_whatsapp_chat

Read WhatsApp chat

Read key

One WhatsApp chat with its messages, oldest first: direction, text, what was sent from the phone, delivery status.

Body

idstringrequired

Chat 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/reply_whatsapp_chat

Reply on WhatsApp

Read and write key

Replies in one of the person’s own WhatsApp chats, from their own number.

Body

idstringrequired

Chat id

textstringrequired

The message, up to 4,096 characters

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/list_whatsapp_templates

List WhatsApp templates

Read key

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

idstringrequired

Chat id

freshboolean

Ask 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/send_whatsapp_template

Send WhatsApp template

Read and write key

Sends an approved template into one of the person’s own WhatsApp chats, its blanks filled in order (params).

Body

idstringrequired

Chat id

namestringrequired

Template name

languagestringrequired

Template language code, e.g. en

paramsarray of string

One value per blank, in order

confirmbooleanrequired

True 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/set_whatsapp_chat_status

Bring in or ignore a WhatsApp chat

Read and write key

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

idstringrequired

Chat id

statusstringrequired

One 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/link_whatsapp_chat

Link WhatsApp chat

Read and write key

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

idstringrequired

Chat id

objectstringrequired

One of contacts companies deals

recordIdnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/unlink_whatsapp_chat

Unlink WhatsApp chat

Read and write key

Takes a WhatsApp chat off a record it was linked to.

Body

idstringrequired

Chat id

objectstringrequired

One of contacts companies deals

recordIdnumberrequired

Record 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/highlight_report

Highlight a report

Read and write key

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

reportstringrequired

The report: its id (rp_…), or its name as the Reports list shows it

markupstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/clear_report_highlight

Clear a report card

Read and write key

Takes down your own card on a report: the one with this topic, or all of yours there when no topic is given.

Body

reportstringrequired

The report: its id (rp_…), or its name as the Reports list shows it

topicstring

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/highlight_insights

Highlight the Insights page

Read and write key

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

markupstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/clear_insights_highlight

Clear an Insights card

Read and write key

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

topicstring

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/read_report

Read a report

Read key

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

reportstringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/find_missing_details

Find missing details

Read and write key

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

objectstringrequired

contacts or companies

idnumberrequired

Record id

fieldsarray of stringrequired

The 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/get_find_options

Find options and credits

Read key

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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}
POST/actions/find_missing_details_bulk

Find missing details on many records

Read and write key

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

objectstringrequired

contacts or companies

idsarray of numberrequired

Record ids, up to 200

fieldsarray of stringrequired

Field 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"]
Response · 200
{
  "data": {
    "id": 101,
    "…": "…"
  },
  "request_id": "req_7c1f0e2a9b4d"
}