Postman Collection - Essal Developer Docs

The official Essal Postman collection provides pre-built requests for every endpoint across all six apps. It includes example request bodies, environment variables, and a pre-request script that handles authentication automatically.

Importing the Collection

Open Postman
Click Import
Enter the collection URL:
https://api.essal.cloud/postman/essal-v1.json
Or download from the Essal GitHub repository

Setting Up the Environment

Click Environments → Add
Create a new environment called Essal Production with these variables:

Variable	Value
`base_url`	`https://api.essal.cloud/v1`
`api_key`	Your API key (`esk_live_...`)

For sandbox testing, create a second environment with base_url set to https://sandbox.essal.cloud/v1 and a sandbox API key.

Collection Structure

The collection mirrors the API structure:

Essal API v1
├── Office
│   ├── Documents
│   ├── Sheets
│   └── Files
├── Access
│   ├── Users
│   ├── Groups
│   └── Sessions
├── Sales
│   ├── Contacts
│   ├── Deals
│   └── Pipelines
├── Careers
│   ├── Jobs
│   ├── Applications
│   └── Stages
├── Project
│   ├── Projects
│   ├── Tasks
│   └── Time Entries
└── Guard
    ├── Policies
    ├── Audit Logs
    └── Alerts

Running the Collection

Use Postman’s Collection Runner to run a full end-to-end sequence — for example, creating a contact, creating a deal, and advancing it through stages — in a single automated run.