Plazbot Developer Hub
Automation
Contact
Opportunity
Workspace
Opportunity
Get Opportunity
Servicio que extrae toda la informacion de las oportunidades.
GET
/
api
/
opportunity
curl --request GET \
--url https://api.plazbot.com/api/opportunity \
--header 'x-workspace-id: <x-workspace-id>'
{
"success": true,
"code": 200,
"errorCode": null,
"message": "List obtained successfully.",
"data": {
"workspaceId": "string",
"continuationToken": null,
"data": [
{
"id": "string",
"opportCode": "string",
"opportStatus": 1,
"winLossStatus": 0,
"winLossDate": null,
"finalAmount": 0,
"creationDate": "2025-04-01T17:05:45.9087344Z",
"creationTypeId": 1,
"updatedDate": null,
"deletionDate": null,
"userDeletion": null,
"statusId": 1,
"files": [],
"orderInCards": 1,
"orderInCardsLastUpdated": "2025-04-01T17:05:45.9335789Z",
"activities": [],
"segmentationId": null,
"workspaceId": "string",
"name": "string",
"description": "string",
"amount": 0,
"userCreation": "string",
"contactId": "",
"expirationDate": "2025-04-30T00:00:00",
"assignedAgentId": null,
"stageId": "string"
}
]
}
}
Headers
Query Parameters
Workspace ID
Token de Paginacion de 20 Registros.
Response
200 - application/json
OK
The response is of type object
.
curl --request GET \
--url https://api.plazbot.com/api/opportunity \
--header 'x-workspace-id: <x-workspace-id>'
{
"success": true,
"code": 200,
"errorCode": null,
"message": "List obtained successfully.",
"data": {
"workspaceId": "string",
"continuationToken": null,
"data": [
{
"id": "string",
"opportCode": "string",
"opportStatus": 1,
"winLossStatus": 0,
"winLossDate": null,
"finalAmount": 0,
"creationDate": "2025-04-01T17:05:45.9087344Z",
"creationTypeId": 1,
"updatedDate": null,
"deletionDate": null,
"userDeletion": null,
"statusId": 1,
"files": [],
"orderInCards": 1,
"orderInCardsLastUpdated": "2025-04-01T17:05:45.9335789Z",
"activities": [],
"segmentationId": null,
"workspaceId": "string",
"name": "string",
"description": "string",
"amount": 0,
"userCreation": "string",
"contactId": "",
"expirationDate": "2025-04-30T00:00:00",
"assignedAgentId": null,
"stageId": "string"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.