Get started
Quickstart
Create a key, list some records, then create one. Each step shows the exact request to send.
1. Create an API key
In Spartivo open Setup → Developer space → API keys and create a key. The full key starts with wk_ and is shown once, so copy it somewhere safe. Requests made with it act as you, with your profile and role.
Treat a key like a password. Keep it on your server, never in a web page or a mobile app, and delete it in Setup if it leaks.
2. List records
Ask for the first five leads. Replace wk_your_key with your key.
curl "https://api.spartivo.com/api/v1/modules/leads/records?pageSize=5" \
-H "Authorization: Bearer wk_your_key"3. Create a record
A record has a name and a data map. The keys of data are field API names, which you can see in Setup → Modules & fields or with List modules.
curl -X POST "https://api.spartivo.com/api/v1/modules/leads/records" \
-H "Authorization: Bearer wk_your_key" \
-H "Content-Type: application/json" \
-d '{"name": "Aisha Khan", "data": {"email": "aisha@example.com", "company": "Northwind Trading"}}'The response is the new record. Workflow rules, assignment rules and validation rules run exactly as they do when someone creates the record in the app.
Response
{
"id": "a0d3bf2c-688d-42da-83e1-d5e57d3e990d",
"ownerId": "035607f1-9fd1-44bc-ac7f-d5128d5afc22",
"name": "Aisha Khan",
"data": {
"email": "aisha@example.com",
"company": "Northwind Trading",
"source": "whatsapp",
"status": "new"
},
"tags": [
"api"
],
"score": 0,
"createdAt": "2026-11-18T08:33:18.996Z",
"updatedAt": "2026-11-18T08:33:18.996Z",
"deletedAt": null
}Next steps
- Filter, sort and page through records in Records.
- Receive events on your server with Webhooks.
- Put logic inside the CRM with Spartivo Script.