Expanding the public REST API
C
Celeste Perez
Currently, the GET /conversations endpoint returns basic metadata but completely lacks any reference to the process, deal, or contact it belongs to.
Example of current response:
{
"data": [
{
"created_at": "2026-05-07T17:30:14Z",
"updated_at": "2026-05-07T17:30:14Z",
"id": "cb5ff44f-dd63-4ca4-820b-d3df663b78ae",
"subject": null,
"snippet": null,
"kind": "email",
"status": "closed",
"assigned": false,
"inbox": "leasing@ncrentals247.com",
"first_call": null,
"first_email": null,
"first_text_message": null,
"last_activity_at": null
}
We request an expanded version of this endpoint. Ideally, this could be achieved in one of two ways:
- Append an array of IDs for related objects directly into the root object of each conversation (similar to how your Data API structures it).
- Allow an optional query parameter, such as GET /conversations?include=processes, to dynamically inject the related process data.
We need the response to include a process_ids array (or a process object) containing the ID(s) of the process linked to each conversation.
Without these IDs, it is technically impossible for our external system to know which conversation belongs to which pipeline or workflow inside LeadSimple. Adding these association arrays will allow us to successfully sync and map our communication history automatically.
Please let me know if this specification is clear enough for your engineering team to review, or if you need any further technical details