API

Build on the platform

Every module in Faraz Growth is backed by a REST API. Read data, create records, and wire growth intelligence into the tools you build.

Authentication

Authenticate with your workspace API key sent as a bearer token:

Authorization: Bearer YOUR_API_KEY

Base URL

https://growth.faraz.app/api

Example — list relationships

curl https://growth.faraz.app/api/relationships \
  -H "Authorization: Bearer YOUR_API_KEY"

Example — create a follow-up action

curl -X POST https://growth.faraz.app/api/actions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Follow up with Acme","due":"2026-08-15","relation_id":"..."}'

Endpoints

GET /api/relationships — list contacts, companies, and deals
POST /api/relationships — create a relationship
GET /api/campaigns — list campaigns
POST /api/campaigns — create a campaign
GET /api/actions — list actions
POST /api/actions — create an action
GET /api/analytics/roi — ROI analytics

Rate limits & errors

API requests are rate limited per key. Errors return standard JSON with an error field and an appropriate HTTP status. Full reference is available in your workspace under Settings → API.

Get your API key

API keys live in your workspace settings. Company plan includes full API access.

Open workspace →

Developer docs

Detailed endpoint reference, schemas, and examples.

Read the docs →