डेवलपर्स

REST API

पाँच तरह के रिकॉर्ड, हर एक पर वही पाँच ऑपरेशन, अंदर और बाहर JSON।

https://api.trypromptlab.com/api/v1

बेस URL

Authorization: Bearer pl_live_…

ऑथ हेडर

10 / सेकंड
300 / मिनट
10,000 / घंटा

हर API की पर रेट लिमिट · 429

API की

SettingsDevelopersAPI keysवर्कस्पेस के मालिक और एडमिन

बनाते समय सिर्फ़ एक बार दिखती है।
इसे बनाने वाले एडमिन की तरह काम करती है, उन्हीं अनुमतियों के साथ।
वह व्यक्ति वर्कस्पेस छोड़ दे तो काम करना बंद कर देती है।
इसे कभी भी रद्द किया जा सकता है।

एंडपॉइंट

GET	`/{resource}`	सूची
GET	`/{resource}/{id}`	एक पाइए
POST	`/{resource}`	बनाइए
PATCH	`/{resource}/{id}`	बदलिए
DELETE	`/{resource}/{id}`	मिटाइए

{resource} इनमें से एक हैcontacts companies deals notes tasks

उदाहरण

अनुरोध

curl -X POST https://api.trypromptlab.com/api/v1/companies \
  -H "Authorization: Bearer pl_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","website":"https://acme.com"}'

जवाब · 201

{
  "data": {
    "id": "665f1c2a9b1e8a0012ab34cd",
    "object": "company",
    "name": "Acme",
    "website": "https://acme.com",
    "createdAt": "2026-10-22T08:15:51.000Z",
    "updatedAt": "2026-10-22T08:15:51.000Z"
  }
}

PATCH · अनुरोध

curl -X PATCH https://api.trypromptlab.com/api/v1/deals/<id> \
  -H "Authorization: Bearer pl_live_…" \
  -H "Content-Type: application/json" \
  -d '{"stage":"QUALIFIED"}'

जवाब

सूची

{
  "data": [ … ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

मिटाना

{
  "data": {
    "id": "665f1c2a…",
    "deleted": true
  }
}

त्रुटि

{
  "statusCode": 401,
  "message": "…",
  "error": "invalid_api_key"
}

त्रुटियाँ

स्टेटस	मतलब
400	बॉडी या क्वेरी गलत है। अनजान फ़ील्ड पर `property X should not exist` मिलता है।
401	API की नहीं है, गलत है या रद्द हो चुकी है
403	API की बनाने वाले एडमिन के पास इस रिकॉर्ड या काम की पहुँच नहीं है
404	इस id का कोई रिकॉर्ड नहीं
429	रेट लिमिट पार: रुकिए और फिर कोशिश कीजिए
500	सर्वर त्रुटि: बाद में फिर कोशिश कीजिए। API की अब भी काम करती है।

रिसोर्स

limit: अधिकतम 100, डिफ़ॉल्ट 10। sortOrder: asc या desc।

/contacts

"object": "contact"

फ़ील्ड	टाइप	नोट्स
`firstName`	string	ज़रूरी
`lastName`	string
`middleName`	string
`jobTitle`	string
`department`	string
`decisionRole`	enum	DECISION_MAKERINFLUENCERTECHNICAL_EVALUATORBUYERPROCUREMENTEND_USERGATEKEEPER
`email`	string
`emails`	string[]
`phone`	object	valuelabel: work \| mobile \| home \| other
`phoneNumbers`	object[]	valuelabel: work \| mobile \| home \| other
`linkedIn`	string
`address`	object	streetAddresscitystatezipCodecountry
`region`	string
`accountId`	id→ companies
`leadId`	id→ deals
`isPrimary`	boolean
`customFields`	object

सूची के फ़िल्टरpagelimitsearchaccountIdleadIdsortBysortOrder

/companies

"object": "company"

फ़ील्ड	टाइप	नोट्स
`name`	string	ज़रूरी
`website`	string
`linkedIn`	string
`phone`	string
`address`	object	streetAddresscitystatezipCodecountry
`region`	string
`primaryIndustry`	string
`businessType`	enum	MANUFACTURERDISTRIBUTORTRADEREND_USER
`description`	string
`source`	string
`estimatedAnnualRevenue`	number
`employeeCount`	number
`ownerId`	id
`customFields`	object

सूची के फ़िल्टरpagelimitsearchprimaryIndustrybusinessTypesortBysortOrder

/deals

"object": "deal"

डील का स्टेज PATCH और नए stage से बदलिए।

फ़ील्ड	टाइप	नोट्स
`name`	string
`accountId`	id→ companies	ज़रूरी
`contactIds`	id[]→ contacts
`assignedSalesOwner`	id
`stage`	string
`priority`	enum	LOWMEDIUMHIGH
`source`	enum	EXPOLINKEDINDIRECT_MEETINGWEBSITE_INQUIRYDISTRIBUTOR_REFERRALCOLD_CALLEXISTING_CUSTOMER_REFERRALCONFERENCEEMAIL_CAMPAIGNEMAILTRADE_PUBLICATIONSALESFORCEHUBSPOTACUMATICAOTHER
`lossReason`	enum	PRICECOMPETITORTIMINGNO_BUDGETPRODUCT_FITOTHER
`closeDate`	date
`estimatedOpportunityValueUSD`	number
`expectedAnnualVolumeMT`	number
`nextFollowUpDate`	date
`customFields`	object

सूची के फ़िल्टरpagelimitsearchstageaccountIdcontactIdassignedSalesOwnersortBysortOrder

/notes

"object": "note"

फ़ील्ड	टाइप	नोट्स
`content`	string	ज़रूरी
`title`	string
`accountId`	id→ companies
`contactId`	id→ contacts
`leadId`	id→ deals
`customFields`	object

सूची के फ़िल्टरpagelimitaccountIdcontactIdleadId

/tasks

"object": "task"

टास्क PATCH और "status": "completed" से बंद कीजिए।

फ़ील्ड	टाइप	नोट्स
`name`	string	ज़रूरी
`description`	string
`assigneeIds`	id[]
`priority`	enum	lowmediumhighurgent
`taskType`	string
`dueDate`	date
`accountId`	id→ companies
`contacts`	id[]→ contacts
`opportunityId`	id→ deals
`customFields`	object
`status`	enum	सिर्फ़ PATCHtodoin_progresscompletedexpired

सूची के फ़िल्टरpagelimitsearchstatusaccountIdcontactIdopportunityIdsortBysortOrder