Plazbot Developer Hub
Automation
Contact
Opportunity
Workspace
Contact
Get Contacts
Servicio para obtener los contactos del Workspace.
GET
/
api
/
contact
curl --request GET \
--url https://api.plazbot.com/api/contact \
--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",
"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"
}
]
}
}
Headers
Query Parameters
Workspace ID
Token que trae los siguientes 20 registros. En caso se obtenga menos de 20, el campo llega Null.
Response
200 - text/plain
OK
The response is of type object
.
curl --request GET \
--url https://api.plazbot.com/api/contact \
--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",
"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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.