Plazbot
  1. Contact
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. Contact

Get Contact By Id

GET
/api/contact/{contactId}
contact
Servicio que trae el contacto filtrado por contact ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plazbot.com/api/contact/?workspaceId' \
--header 'x-workspace-id: wok_generatedcode'
Response Response Example
{
  "success": true,
  "code": 200,
  "errorCode": null,
  "message": "Successfully obtained list.",
  "data": {
    "contactId": "string",
    "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

Path Params
contactId
string 
required
Query Params
workspaceId
string 
required
Header Params
x-workspace-id
string 
optional
Example:
wok_generatedcode

Responses

🟢200OK
application/json
OK
Body
success
boolean 
required
code
integer 
required
errorCode
null 
required
message
string 
required
data
object 
required
contactId
string 
required
data
array [object {25}] 
required
Previous
Update Contact
Next
Get Contact By Email
Built with