Desenvolvedores

API REST

Cinco tipos de registro, as mesmas cinco operações em cada um, JSON na entrada e na saída.

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

URL base

Authorization: Bearer pl_live_…

Cabeçalho de autenticação

10 / segundo
300 / minuto
10.000 / hora

Limites de requisições por chave · 429

Chaves de API

SettingsDevelopersAPI keysProprietários e administradores do workspace

Exibida uma única vez, ao ser criada.
Age como o administrador que a criou, com as mesmas permissões.
Deixa de funcionar se essa pessoa sair do workspace.
Revogue-a quando quiser.

Endpoints

GET	`/{resource}`	Listar
GET	`/{resource}/{id}`	Obter um
POST	`/{resource}`	Criar
PATCH	`/{resource}/{id}`	Atualizar
DELETE	`/{resource}/{id}`	Excluir

{resource} é um destescontacts companies deals notes tasks

Exemplo

Requisição

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"}'

Resposta · 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 · Requisição

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

Respostas

Lista

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

Exclusão

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

Erro

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

Erros

Status	Significado
400	Corpo ou parâmetros inválidos. Um campo desconhecido retorna `property X should not exist`.
401	Chave ausente, errada ou revogada
403	O administrador da chave não tem acesso a este registro ou ação
404	Nenhum registro com este id
429	Acima do limite: espere e tente de novo
500	Erro no servidor: tente de novo mais tarde. A chave continua válida.

Recursos

limit: máximo 100, padrão 10. sortOrder: asc ou desc.

/contacts

"object": "contact"

Campo	Tipo	Observações
`firstName`	string	Obrigatório
`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

Filtros da listapagelimitsearchaccountIdleadIdsortBysortOrder

/companies

"object": "company"

Campo	Tipo	Observações
`name`	string	Obrigatório
`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

Filtros da listapagelimitsearchprimaryIndustrybusinessTypesortBysortOrder

/deals

"object": "deal"

Mova um negócio com PATCH e uma nova stage.

Campo	Tipo	Observações
`name`	string
`accountId`	id→ companies	Obrigatório
`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

Filtros da listapagelimitsearchstageaccountIdcontactIdassignedSalesOwnersortBysortOrder

/notes

"object": "note"

Campo	Tipo	Observações
`content`	string	Obrigatório
`title`	string
`accountId`	id→ companies
`contactId`	id→ contacts
`leadId`	id→ deals
`customFields`	object

Filtros da listapagelimitaccountIdcontactIdleadId

/tasks

"object": "task"

Conclua uma tarefa com PATCH e "status": "completed".

Campo	Tipo	Observações
`name`	string	Obrigatório
`description`	string
`assigneeIds`	id[]
`priority`	enum	lowmediumhighurgent
`taskType`	string
`dueDate`	date
`accountId`	id→ companies
`contacts`	id[]→ contacts
`opportunityId`	id→ deals
`customFields`	object
`status`	enum	Só no PATCHtodoin_progresscompletedexpired

Filtros da listapagelimitsearchstatusaccountIdcontactIdopportunityIdsortBysortOrder