API Reference

The NEXUS REST API provides programmatic access to your relationship intelligence data. All endpoints return JSON and follow standard HTTP conventions.

Base URL

https://api.nexusrelate.com

Authentication

Authenticate via an HTTP-only session cookie (nexus_session) set after federated login, a scoped API key (nxs_live_…), or a Bearer token in the Authorization header.

Stability

All endpoints are versioned under /v1. Breaking changes receive a deprecation window and a migration guide before rollout.

Endpoints

Auth

POST /v1/auth/session/federatedPOST /v1/auth/session/refreshDELETE /v1/auth/sessionGET /v1/auth/bootstrap

Records

GET /v1/recordsPOST /v1/recordsGET /v1/records/:idPUT /v1/records/:idDELETE /v1/records/:idGET /v1/records/:id/relationsGET /v1/records/:id/activities

Objects

GET /v1/objectsPOST /v1/objects

Posts

GET /v1/postsPOST /v1/postsGET /v1/posts/:idPUT /v1/posts/:idDELETE /v1/posts/:idGET /v1/posts/public/:handle

Campaigns

GET /v1/campaignsPOST /v1/campaignsGET /v1/attributionGET /v1/budget

Transduction

POST /v1/transduceGET /v1/transductions

Agent

POST /v1/mcp/tools/listPOST /v1/mcp/tools/callGET /v1/approvalsPOST /v1/approvals/:id/approve

Testing

GET /v1/testing/suitesPOST /v1/testing/suitesGET /v1/testing/runsPOST /v1/testing/analyze

Billing

GET /v1/billing/currentPOST /v1/billing/checkout

Audit

GET /v1/audit

Example

Create a new CRM record:

curl -X POST \
  https://api.nexusrelate.com/v1/records \
  -H "Content-Type: application/json" \
  -H "Cookie: nexus_session=<session_token>" \
  -d '{
    "object": "contact",
    "attributes": {
      "name": "Acme Corp",
      "industry": "Technology",
      "stage": "prospect"
    }
  }'

← Back to home