API reference

• GET /api/v1/contacts
• POST /api/v1/contacts
• GET /api/v1/contacts/{id}
• PATCH /api/v1/contacts/{id}
• DELETE /api/v1/contacts/{id}

Filters: email (eq, in) · phone (eq) · source (eq, in) · tags (contains) · name (search) · consent_marketing (eq) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at. Writable on create: name, email, phone, tags, attributes, source, consent_marketing.

curl "https://app.originpixel.in/api/v1/contacts?limit=25&email=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/contacts" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Priya Raman","email":"priya@example.com","phone":"+919840012345","tags":["vip"]}'

• GET /api/v1/leads
• POST /api/v1/leads
• GET /api/v1/leads/{id}
• PATCH /api/v1/leads/{id}

Filters: stage (eq, neq, in) · source (eq, in) · contact_id (eq) · owner_id (eq) · score (gte, lte, gt, lt) · tags (contains) · name (search) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at, last_activity_at. Writable on create: name, contact_id, stage, value_estimate, currency, source, tags, next_action, next_action_due.

curl "https://app.originpixel.in/api/v1/leads?limit=25&stage=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/leads" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Website enquiry - dental implant","source":"website","value_estimate":45000,"currency":"INR"}'

• GET /api/v1/conversations
• GET /api/v1/conversations/{id}

Filters: status (eq, in) · contact_id (eq) · channel_id (eq) · tags (contains) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at.

curl "https://app.originpixel.in/api/v1/conversations?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/messages
• GET /api/v1/messages/{id}

Filters: conversation_id (eq) · direction (eq) · sender_kind (eq, in) · created_at (gt, gte, lt, lte). Sort: created_at.

curl "https://app.originpixel.in/api/v1/messages?limit=25&conversation_id=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/bookings
• POST /api/v1/bookings
• GET /api/v1/bookings/{id}
• PATCH /api/v1/bookings/{id}

Filters: status (eq, in) · contact_id (eq) · service_id (eq) · resource_id (eq) · starts_at (gt, gte, lt, lte) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: starts_at, created_at, updated_at. Writable on create: contact_id, service_id, resource_id, starts_at, ends_at, status, notes.

curl "https://app.originpixel.in/api/v1/bookings?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/bookings" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"starts_at":"2026-11-05T10:00:00+05:30","ends_at":"2026-11-05T10:30:00+05:30","status":"requested"}'

• GET /api/v1/tickets
• POST /api/v1/tickets
• GET /api/v1/tickets/{id}
• PATCH /api/v1/tickets/{id}

Filters: status (eq, neq, in) · priority (eq, in) · category (eq) · contact_id (eq) · assignee_id (eq) · tags (contains) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at, number. Writable on create: subject, description, priority, category, channel, contact_id, tags.

curl "https://app.originpixel.in/api/v1/tickets?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/tickets" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"subject":"Order arrived damaged","priority":"high","channel":"email"}'

• GET /api/v1/reviews
• POST /api/v1/reviews
• GET /api/v1/reviews/{id}

Filters: rating (eq, gte, lte) · status (eq, in) · source_id (eq) · sentiment (eq, in) · reviewed_at (gt, gte, lt, lte) · created_at (gt, gte, lt, lte). Sort: reviewed_at, created_at, updated_at. Writable on create: source_id, rating, body, author_display, reviewed_at, source_url, external_id.

curl "https://app.originpixel.in/api/v1/reviews?limit=25&rating=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/reviews" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"source_id":"2f1c0a9e-5b7d-4c3a-9e8f-1a2b3c4d5e6f","rating":5,"body":"Very kind staff.","author_display":"Karthik S"}'

• GET /api/v1/calls
• GET /api/v1/calls/{id}

Filters: direction (eq) · status (eq, in) · outcome (eq, in) · contact_id (eq) · lead_id (eq) · campaign_id (eq) · is_test (eq) · started_at (gt, gte, lt, lte) · created_at (gt, gte, lt, lte). Sort: started_at, created_at, updated_at.

curl "https://app.originpixel.in/api/v1/calls?limit=25&direction=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/campaigns
• GET /api/v1/campaigns/{id}

Filters: status (eq, in) · sequence_id (eq) · created_at (gt, gte, lt, lte). Sort: created_at, updated_at.

curl "https://app.originpixel.in/api/v1/campaigns?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/voice-campaigns
• GET /api/v1/voice-campaigns/{id}

Filters: status (eq, in) · agent_id (eq) · created_at (gt, gte, lt, lte). Sort: created_at, updated_at.

curl "https://app.originpixel.in/api/v1/voice-campaigns?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/prospects
• POST /api/v1/prospects
• GET /api/v1/prospects/{id}
• PATCH /api/v1/prospects/{id}

Filters: status (eq, in) · region (eq, in) · account_id (eq) · email (eq) · owner_id (eq) · name (search) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at. Writable on create: name, title, email, phone, linkedin_url, timezone, region, lawful_basis, basis_note, account_id, source, notes.

curl "https://app.originpixel.in/api/v1/prospects?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/prospects" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Anand Iyer","title":"Head of Operations","email":"anand@acme.example","region":"in","lawful_basis":"consent"}'

• GET /api/v1/documents
• GET /api/v1/documents/{id}

Filters: status (eq, in) · doc_type_id (eq) · scan_status (eq) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at.

curl "https://app.originpixel.in/api/v1/documents?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/records
• GET /api/v1/records/{id}

Filters: kind (eq, in) · status (eq, in) · party_id (eq) · issue_date (gte, lte) · due_date (gte, lte) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at.

curl "https://app.originpixel.in/api/v1/records?limit=25&kind=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

• GET /api/v1/posts
• POST /api/v1/posts
• GET /api/v1/posts/{id}
• PATCH /api/v1/posts/{id}

Filters: status (eq, in) · channel (eq, in) · plan_id (eq) · publish_date (gte, lte) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at. Writable on create: channel, title, caption, hashtags, alt_text, link_url, language, publish_date, publish_time.

curl "https://app.originpixel.in/api/v1/posts?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/posts" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"channel":"instagram","caption":"Diwali offer: 20% off cleaning this week."}'

• GET /api/v1/knowledge-articles
• POST /api/v1/knowledge-articles
• GET /api/v1/knowledge-articles/{id}
• PATCH /api/v1/knowledge-articles/{id}
• DELETE /api/v1/knowledge-articles/{id}

Filters: status (eq, in) · published (eq) · source_kind (eq) · title (search) · created_at (gt, gte, lt, lte) · updated_at (gt, gte, lt, lte). Sort: created_at, updated_at. Writable on create: title, content, source_kind, published, slug.

curl "https://app.originpixel.in/api/v1/knowledge-articles?limit=25&status=..." \
  -H "Authorization: Bearer $ORIGIN_API_KEY"

curl -X POST "https://app.originpixel.in/api/v1/knowledge-articles" \
  -H "Authorization: Bearer $ORIGIN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"title":"Parking","content":"Free parking is available behind the clinic from 9 am to 9 pm."}'

Metrics

The Business Intelligence engine over every product, in the business's timezone. Scope business_intelligence:read.

GET /api/v1/metrics
GET /api/v1/metrics/revenue.leads?from=2026-10-01&to=2026-10-31&grain=week&compare=true