Plazbot

Get Opportunity

GET

/api/opportunity

opportunity

Servicio que extrae toda la informacion de las oportunidades.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plazbot.com/api/opportunity?workspaceId&continuationToken&fCardsOrderBy&stageId&viewId' \
--header 'x-workspace-id;'

Response Example

{
  "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"
      }
    ]
  }
}

Request

Query Params

workspaceId

string

required

Workspace ID

continuationToken

string

optional

Token de Paginacion de 20 Registros.

fCardsOrderBy

boolean

optional

Ordenamiento de las oportunidades.

Default:

false

stageId

string

optional

Campo para filtrar las oportunidades por Fase.

Default:

viewId

string

optional

Campo para filtraer las oportunidades por Vista.

Default:

Header Params

x-workspace-id

string

required

Responses

🟢200OK

application/json

Body

success

boolean

required

code

integer

required

errorCode

null

required

message

string

required

data

object

required

workspaceId

string

required

continuationToken

null

required

data

array [object {26}]

required

Send Conversation

Create Opportunity