Skip to main content

Fetch Process API

The following APIs allow you to fetch a single process. Examples of a process are models like: Lead, Ticket, FieldVisit.

Note: All the apis accept api key based token authentication and return data within the wrapper { _data:{}, _meta: {}, _errors:[] }

Fetch by processId​

GET /v1/ext/procedure/<procedureShortId>/process/<processId>

Following are valid examples of the path

GET /v1/ext/procedure/lead/process/1bc10281-5882-43aa-b48d-28c527335e7a
GET /v1/ext/procedure/ticket/process/705bab28-0042-43d5-9b7f-6e72eb411b5b
GET /v1/ext/procedure/fieldvisit/process/c6216cc5-81d1-4741-941d-a1a65751a8aa

Fetch by primaryKey value​

GET /v1/ext/procedure/<procedureShortId>/process/<primaryKeyShortId>/<primaryKeyValue>

Following are valid examples of the path

GET /v1/ext/procedure/lead/process/lead_id/LEAD-001
GET /v1/ext/procedure/ticket/process/ticket_id/1
GET /v1/ext/procedure/fieldvisit/process/fieldvisit_id/abc123