ChakraHQ APIs

Fetch Process By Id

GET

https://api.chakrahq.com/v1/ext/procedure/{procedureShortId}/process/{processId}

This API allow you to fetch a single process. Examples of a process are models like: Lead, Ticket, FieldVisit.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

procedureShortId

string

required

Example:

lead

processId

string

required

Example:

1bc10281-5882-43aa-b48d-28c527335e7a

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.chakrahq.com/v1/ext/procedure/lead/process/1bc10281-5882-43aa-b48d-28c527335e7a'

Responses

🟢200Success

application/json

Body

data

object

required

firstname

string

required

lastname

string

required

score

integer

required

record

object

required

data

object

required

status

string

required

state

string

required

nextActionAt

integer

required

assignedTo

string

required

Example

{
  "data": {
    "firstname": "Ted",
    "lastname": "Mosby",
    "score": 5
  },
  "record": {
    "data": {
      "phone_number": "7701214822",
      "email": "ted.mosby@yahoo.com"
    }
  },
  "status": "COMPLETED",
  "state": "CONVERTED",
  "nextActionAt": 1618558867539,
  "assignedTo": "bcc42c4f-3e9c-4eaa-8728-c1edd7c7be5c"
}

Whatsapp Messages API (pass-through)

List Processes