Misc API

Misc endpoints exposed by the Devotel CPaaS API Base path: /api/v1 Endpoint count: 40

GET /auth/saml/{orgSlug}/login

string

required

—

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl "https://api.orbit.devotel.io/auth/saml/{orgSlug}/login" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/auth/saml/{orgSlug}/login', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/auth/saml/{orgSlug}/login", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List logout

GET /auth/saml/{orgSlug}/logout

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/auth/saml/{orgSlug}/logout" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/auth/saml/{orgSlug}/logout', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/auth/saml/{orgSlug}/logout", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List metadata

GET /auth/saml/{orgSlug}/metadata

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/auth/saml/{orgSlug}/metadata" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/auth/saml/{orgSlug}/metadata', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/auth/saml/{orgSlug}/metadata", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get goalId

GET /g/{goalId}/{contactId}.gif

string

required

—

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/g/{goalId}/{contactId}.gif" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/g/{goalId}/{contactId}.gif', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/g/{goalId}/{contactId}.gif", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get l

GET /l/{code}

string

required

—

cURL

curl "https://api.orbit.devotel.io/l/{code}" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/l/{code}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/l/{code}", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get lp

GET /lp/{code}

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/lp/{code}" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/lp/{code}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/lp/{code}", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get p

GET /p/{sig}.gif

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/p/{sig}.gif" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/p/{sig}.gif', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/p/{sig}.gif", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get r

GET /r/{code}

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/r/{code}" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/r/{code}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/r/{code}", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get sig

GET /r/{sig}/{target}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/r/{sig}/{target}" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/r/{sig}/{target}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/r/{sig}/{target}", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List Agents

GET /scim/v2/{orgSlug}/Agents

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get Agents

GET /scim/v2/{orgSlug}/Agents/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List Groups

GET /scim/v2/{orgSlug}/Groups

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get Groups

GET /scim/v2/{orgSlug}/Groups/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List ResourceTypes

GET /scim/v2/{orgSlug}/ResourceTypes

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/ResourceTypes" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/ResourceTypes', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/ResourceTypes", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List Schemas

GET /scim/v2/{orgSlug}/Schemas

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Schemas" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Schemas', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Schemas", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List ServiceProviderConfig

GET /scim/v2/{orgSlug}/ServiceProviderConfig

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/ServiceProviderConfig" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/ServiceProviderConfig', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/ServiceProviderConfig", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List Users

GET /scim/v2/{orgSlug}/Users

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get Users

GET /scim/v2/{orgSlug}/Users/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List feed

GET /sdk/in-app/feed

cURL

curl "https://api.orbit.devotel.io/sdk/in-app/feed" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/in-app/feed', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/sdk/in-app/feed", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List personalize

GET /sdk/personalize

cURL

curl "https://api.orbit.devotel.io/sdk/personalize" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/personalize', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/sdk/personalize", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create callback

POST /auth/saml/{orgSlug}/callback

string

required

—

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/auth/saml/{orgSlug}/callback" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/auth/saml/{orgSlug}/callback', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/auth/saml/{orgSlug}/callback", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create alias

POST /cdp/v1/{ingest_id}/alias

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/alias" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/alias', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/alias", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create batch

POST /cdp/v1/{ingest_id}/batch

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/batch" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/batch', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/batch", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create group

POST /cdp/v1/{ingest_id}/group

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/group" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/group', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/group", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create identify

POST /cdp/v1/{ingest_id}/identify

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create page

POST /cdp/v1/{ingest_id}/page

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/page" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/page', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/page", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create screen

POST /cdp/v1/{ingest_id}/screen

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create track

POST /cdp/v1/{ingest_id}/track

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/track" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/track', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/track", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create convert

POST /lp/{code}/convert

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/lp/{code}/convert" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/lp/{code}/convert', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/lp/{code}/convert", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create Users

POST /scim/v2/{orgSlug}/Users

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Identify sdk

POST /sdk/identify

cURL

curl -X POST "https://api.orbit.devotel.io/sdk/identify" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/identify', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/sdk/identify", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Events in-app

POST /sdk/in-app/events

cURL

curl -X POST "https://api.orbit.devotel.io/sdk/in-app/events" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/in-app/events', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/sdk/in-app/events", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Track sdk

POST /sdk/track

cURL

curl -X POST "https://api.orbit.devotel.io/sdk/track" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/track', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/sdk/track", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Anonymous track

POST /sdk/track/anonymous

cURL

curl -X POST "https://api.orbit.devotel.io/sdk/track/anonymous" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/sdk/track/anonymous', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.post("https://api.orbit.devotel.io/sdk/track/anonymous", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Update Users

PUT /scim/v2/{orgSlug}/Users/{id}

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.put("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Patch Agents

PATCH /scim/v2/{orgSlug}/Agents/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.patch("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Patch Groups

PATCH /scim/v2/{orgSlug}/Groups/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.patch("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Groups/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Patch Users

PATCH /scim/v2/{orgSlug}/Users/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.patch("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Delete Agents

DELETE /scim/v2/{orgSlug}/Agents/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.delete("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Delete Users

DELETE /scim/v2/{orgSlug}/Users/{id}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const res = await fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!
  }
});
const data = await res.json();

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.delete("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

​Misc API

​List login

​List logout

​List metadata

​Get goalId

​Get l

​Get lp

​Get p

​Get r

​Get sig

​List Agents

​Get Agents

​List Groups

​Get Groups

​List ResourceTypes

​List Schemas

​List ServiceProviderConfig

​List Users

​Get Users

​List feed

​List personalize

​Create callback

​Create alias

​Create batch

​Create group

​Create identify

​Create page

​Create screen

​Create track

​Create convert

​Create Users

​Identify sdk

​Events in-app

​Track sdk

​Anonymous track

​Update Users

​Patch Agents

​Patch Groups

​Patch Users

​Delete Agents

​Delete Users

Misc API

List login

List logout

List metadata

Get goalId

Get l

Get lp

Get p

Get r

Get sig

List Agents

Get Agents

List Groups

Get Groups

List ResourceTypes

List Schemas

List ServiceProviderConfig

List Users

Get Users

List feed

List personalize

Create callback

Create alias

Create batch

Create group

Create identify

Create page

Create screen

Create track

Create convert

Create Users

Identify sdk

Events in-app

Track sdk

Anonymous track

Update Users

Patch Agents

Patch Groups

Patch Users

Delete Agents

Delete Users