المطورون

REST API

خمسة أنواع من السجلات، والعمليات الخمس نفسها لكل منها، وJSON في الطلب والرد.

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

عنوان URL الأساسي

Authorization: Bearer pl_live_…

ترويسة المصادقة

10 / ثانية
300 / دقيقة
10,000 / ساعة

حدود الطلبات لكل مفتاح · 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	المفتاح مفقود أو خاطئ أو ملغى
403	ليس لدى مسؤول المفتاح صلاحية على هذا السجل أو الإجراء
404	لا يوجد سجل بهذا الـ id
429	تم تجاوز الحد: انتظر ثم أعد المحاولة
500	خطأ في الخادم: أعد المحاولة لاحقًا. المفتاح ما زال صالحًا.

الموارد

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	PATCH فقطtodoin_progresscompletedexpired

مرشحات القائمةpagelimitsearchstatusaccountIdcontactIdopportunityIdsortBysortOrder