Plazbot
  1. Opportunity
Plazbot
  • Plazbot Developer Hub
  • Automation
    • Update Agente IA Prompt
      POST
  • Contact
    • Get Contacts
      GET
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contact By Id
      GET
    • Get Contact By Email
      GET
    • Get Contact By Phone
      GET
    • Update Activities to Contact
      POST
  • Message
    • Send Message Whatsapp
      POST
    • List Conversation
      GET
    • Send Conversation
      POST
  • Opportunity
    • Get Opportunity
      GET
    • Create Opportunity
      POST
    • Get Opportunity by Id
      GET
    • Delete Opportunity
      DELETE
    • Create Activity for Opportunity
      POST
  • Task
    • Create Task
      POST
    • Get Task By Id
      GET
    • Delete Task
      DELETE
  • User
    • Create User
      POST
    • Get Information by Email
      GET
    • Login Access
      POST
    • Send Reset Password
      POST
    • Update Password
      POST
  • Workspace
    • Get Workspace by ID
  1. Opportunity

Get Opportunity by Id

GET
/api/opportunity/{id}
opportunity
Servicio para Obtener una oportunidad filtrado por el ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plazbot.com/api/opportunity/?workspaceId' \
--header 'x-workspace-id;'
Response Response Example
{
  "success": true,
  "code": 200,
  "errorCode": null,
  "message": "List obtained successfully.",
  "data": [
    {
      "id": "string",
      "opportCode": "string",
      "opportStatus": 1,
      "winLossStatus": 0,
      "winLossDate": null,
      "finalAmount": 0,
      "creationDate": "2025-04-08T03:52:53.3774876Z",
      "creationTypeId": 1,
      "updatedDate": null,
      "deletionDate": null,
      "userDeletion": null,
      "statusId": 1,
      "files": [],
      "orderInCards": 1,
      "orderInCardsLastUpdated": "2025-04-08T03:52:54.663308Z",
      "activities": [],
      "segmentationId": null,
      "workspaceId": "string",
      "name": "string",
      "description": "string",
      "amount": 0,
      "userCreation": "string",
      "contactId": "string",
      "expirationDate": null,
      "assignedAgentId": null,
      "stageId": null
    }
  ]
}

Request

Path Params
id
string 
required
Oportunidad ID
Query Params
workspaceId
string 
required
Workspace ID
Header Params
x-workspace-id
string 
required

Responses

🟢200OK
application/json
OK
Body
success
boolean 
required
code
integer 
required
errorCode
null 
required
message
string 
required
data
array [object {26}] 
required
id
string 
optional
opportCode
string 
optional
opportStatus
integer 
optional
winLossStatus
integer 
optional
winLossDate
null 
optional
finalAmount
integer 
optional
creationDate
string 
optional
creationTypeId
integer 
optional
updatedDate
null 
optional
deletionDate
null 
optional
userDeletion
null 
optional
statusId
integer 
optional
files
array[string]
optional
orderInCards
integer 
optional
orderInCardsLastUpdated
string 
optional
activities
array[string]
optional
segmentationId
null 
optional
workspaceId
string 
optional
name
string 
optional
description
string 
optional
amount
integer 
optional
userCreation
string 
optional
contactId
string 
optional
expirationDate
null 
optional
assignedAgentId
null 
optional
stageId
null 
optional
Previous
Create Opportunity
Next
Delete Opportunity
Built with