Dasturchilar

REST API

Beshta yozuv turi, har birida bir xil beshta amal, kirish va chiqishda JSON.

https://api.trypromptlab.com/api/v1
Asosiy URL
Authorization: Bearer pl_live_…
Avtorizatsiya sarlavhasi
  • 10 / soniya
  • 300 / daqiqa
  • 10 000 / soat
Har bir kalit uchun soʻrov limitlari · 429

API kalitlari

SettingsDevelopersAPI keysWorkspace egalari va adminlari
  • Yaratilganda faqat bir marta koʻrsatiladi.
  • Uni yaratgan admin nomidan, xuddi shu huquqlar bilan ishlaydi.
  • Oʻsha odam workspaceʼdan chiqsa, ishlashdan toʻxtaydi.
  • Istalgan vaqtda bekor qilish mumkin.

Endpointlar

GET/{resource}Roʻyxat
GET/{resource}/{id}Bittasini olish
POST/{resource}Yaratish
PATCH/{resource}/{id}Yangilash
DELETE/{resource}/{id}Oʻchirish
{resource} quyidagilardan biricontactscompaniesdealsnotestasks

Misol

Soʻrov
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"}'
Javob · 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 · Soʻrov
curl -X PATCH https://api.trypromptlab.com/api/v1/deals/<id> \
  -H "Authorization: Bearer pl_live_…" \
  -H "Content-Type: application/json" \
  -d '{"stage":"QUALIFIED"}'

Javoblar

Roʻyxat
{
  "data": [ … ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}
Oʻchirish
{
  "data": {
    "id": "665f1c2a…",
    "deleted": true
  }
}
Xato
{
  "statusCode": 401,
  "message": "…",
  "error": "invalid_api_key"
}

Xatolar

StatusMaʼnosi
400Soʻrov tanasi yoki parametrlari notoʻgʻri. Nomaʼlum maydon `property X should not exist` qaytaradi.
401Kalit yoʻq, notoʻgʻri yoki bekor qilingan
403Kalitni yaratgan adminning bu yozuv yoki amalga ruxsati yoʻq
404Bu id bilan yozuv yoʻq
429Limitdan oshdi: kuting va qayta urinib koʻring
500Server xatosi: keyinroq qayta urinib koʻring. Kalit ishlashda davom etadi.

Resurslar

limit: koʻpi bilan 100, standart 10. sortOrder: asc yoki desc.

/contacts

"object": "contact"
MaydonTuriIzohlar
firstNamestringMajburiy
lastNamestring
middleNamestring
jobTitlestring
departmentstring
decisionRoleenumDECISION_MAKERINFLUENCERTECHNICAL_EVALUATORBUYERPROCUREMENTEND_USERGATEKEEPER
emailstring
emailsstring[]
phoneobjectvaluelabel: work | mobile | home | other
phoneNumbersobject[]valuelabel: work | mobile | home | other
linkedInstring
addressobjectstreetAddresscitystatezipCodecountry
regionstring
accountIdid→ companies
leadIdid→ deals
isPrimaryboolean
customFieldsobject
Roʻyxat filtrlaripagelimitsearchaccountIdleadIdsortBysortOrder

/companies

"object": "company"
MaydonTuriIzohlar
namestringMajburiy
websitestring
linkedInstring
phonestring
addressobjectstreetAddresscitystatezipCodecountry
regionstring
primaryIndustrystring
businessTypeenumMANUFACTURERDISTRIBUTORTRADEREND_USER
descriptionstring
sourcestring
estimatedAnnualRevenuenumber
employeeCountnumber
ownerIdid
customFieldsobject
Roʻyxat filtrlaripagelimitsearchprimaryIndustrybusinessTypesortBysortOrder

/deals

"object": "deal"

Bitimni PATCH va yangi stage bilan boshqa bosqichga oʻtkazing.

MaydonTuriIzohlar
namestring
accountIdid→ companiesMajburiy
contactIdsid[]→ contacts
assignedSalesOwnerid
stagestring
priorityenumLOWMEDIUMHIGH
sourceenumEXPOLINKEDINDIRECT_MEETINGWEBSITE_INQUIRYDISTRIBUTOR_REFERRALCOLD_CALLEXISTING_CUSTOMER_REFERRALCONFERENCEEMAIL_CAMPAIGNEMAILTRADE_PUBLICATIONSALESFORCEHUBSPOTACUMATICAOTHER
lossReasonenumPRICECOMPETITORTIMINGNO_BUDGETPRODUCT_FITOTHER
closeDatedate
estimatedOpportunityValueUSDnumber
expectedAnnualVolumeMTnumber
nextFollowUpDatedate
customFieldsobject
Roʻyxat filtrlaripagelimitsearchstageaccountIdcontactIdassignedSalesOwnersortBysortOrder

/notes

"object": "note"
MaydonTuriIzohlar
contentstringMajburiy
titlestring
accountIdid→ companies
contactIdid→ contacts
leadIdid→ deals
customFieldsobject
Roʻyxat filtrlaripagelimitaccountIdcontactIdleadId

/tasks

"object": "task"

Vazifani PATCH va "status": "completed" bilan yoping.

MaydonTuriIzohlar
namestringMajburiy
descriptionstring
assigneeIdsid[]
priorityenumlowmediumhighurgent
taskTypestring
dueDatedate
accountIdid→ companies
contactsid[]→ contacts
opportunityIdid→ deals
customFieldsobject
statusenumFaqat PATCHtodoin_progresscompletedexpired
Roʻyxat filtrlaripagelimitsearchstatusaccountIdcontactIdopportunityIdsortBysortOrder