Plazbot

Get Contacts

GET

/api/contact

contact

Servicio para obtener los contactos del Workspace.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
  "success": true,
  "code": 200,
  "errorCode": null,
  "message": "List obtained successfully.",
  "data": {
    "workspaceId": "string",
    "continuationToken": null,
    "data": [
      {
        "id": "string",
        "creationDate": "2025-03-31T08:04:22.6573965Z",
        "assignedAgentId": "string",
        "assignedAgentName": "string",
        "segmentationId": "string",
        "lastMessage": "string",
        "lastMessageDate": "2025-04-06T20:16:46.808Z",
        "platformSenderId": "string",
        "platformSenderName": "string",
        "platformSenderPhone": "string",
        "isRead": true,
        "isBotEnabled": true,
        "isManuallyAdded": true,
        "avatarColor": null,
        "orderInCards": 42,
        "orderInCardsLastUpdated": "2025-04-06T14:44:38.0807297Z",
        "tags": [
          {
            "id": "",
            "name": "",
            "color": null,
            "assignmentDate": "2025-04-04T17:47:18.1255151Z"
          }
        ],
        "files": [],
        "isSolved": false,
        "workspaceId": "string",
        "name": "string",
        "lastname": "string",
        "email": null,
        "platformId": 2,
        "stageId": "string"
      }
    ]
  }
}

Request

Query Params

workspaceId

string

required

Workspace ID

continuationToken

string

optional

Token que trae los siguientes 20 registros. En caso se obtenga menos de 20, el campo llega Null.

fCardsOrderBy

boolean

optional

Default:

false

viewId

string

optional

Default:

stageId

string

optional

Default:

Header Params

x-workspace-id

string

required

Responses

🟢200OK

text/plain

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

required

Modified at 2025-04-21 17:56:31

Plazbot Developer Hub

Create Contact