Skip to Content
My App
Api

Deal

Manage sales-pipeline deals — create, list, update and move deals between stages.

GET /api/v1/deals — paginated, optional pipeline_id / stage_id / status

GET
/deals

Authorization

http
headerAuthorizationBearer <token>

Response Body

application/json
  1. response
Example Request
curl -X GET 'https://aexrux.com/api/v1/deals'
Example Response200
{}

POST /api/v1/deals — create an opportunity

POST
/deals

Authorization

http
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
title*string
Lengthlength <= 191
pipeline_id?integer|null
stage_id?integer|null
value?|
Range0 <= value <= 99999999
currency?|
Lengthlength <= 10
contact_id?integer|null
owner_user_id?integer|null
expected_close_date?|
Formatdate-time

Response Body

application/json
  1. response
Example Request
curl -X POST 'https://aexrux.com/api/v1/deals' \  -H 'Content-Type: application/json' \  -d '{  "title": "string"}'
Example Response
{}

GET /api/v1/deals/{id}

GET
/deals/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
Example Request
curl -X GET 'https://aexrux.com/api/v1/deals/0'
Example Response200
{}

DELETE /api/v1/deals/{id}

DELETE
/deals/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
Example Request
curl -X DELETE 'https://aexrux.com/api/v1/deals/0'
Example Response200
{}

PUT /api/v1/deals/{id} — update fields (incl. stage to advance it)

PUT
/deals/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Request Body

application/json
  1. body
title?string
Lengthlength <= 191
value?|
Range0 <= value <= 99999999
currency?|
Lengthlength <= 10
stage_id?integer|null
contact_id?integer|null
owner_user_id?integer|null
expected_close_date?|
Formatdate-time
lost_reason?|
Lengthlength <= 191

Response Body

application/json
  1. response
Example Request
curl -X PUT 'https://aexrux.com/api/v1/deals/0' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{}

GET /api/v1/pipelines — the boards and their stages. A caller creating a deal has to name a `stage_id`, and there was no way to discover one over the API without opening the UI. Stage order matters (it is the sales sequence), so it is returned sorted, with the terminal flags a client needs to tell "Won" from "Negotiating"

GET
/pipelines

Authorization

http
headerAuthorizationBearer <token>

Response Body

application/json
  1. response
Example Request
curl -X GET 'https://aexrux.com/api/v1/pipelines'
Example Response200
{}

GET /api/v1/leads — Meta Instant-Form submissions with their ad attribution. Read-only on purpose: leads are produced by Meta, not by API callers, so there is nothing meaningful to POST. Filterable by form, ingest status and date so a nightly sync can pull "everything since yesterday" rather than re-walking the whole table

GET
/leads

Authorization

http
headerAuthorizationBearer <token>

Query Parameters

since?string

Response Body

application/json
  1. response
Example Request
curl -X GET 'https://aexrux.com/api/v1/leads'
Example Response200
{}

Conversation

Read your workspace inbox across EVERY channel: list chat threads (each with its `channel` and the customer id) and fetch the messages inside a thread — WhatsApp, Facebook, Instagram and Telegram alike.

Device

List the WhatsApp numbers / devices connected to your workspace and check each one's connection status.