Skip to the content

Texa DeskDevelopers

Section

Client API · Contacts

Get a contact

GET/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Get the details of a contact

Path parameters

inbox_identifierstringrequired

The identifier obtained from API inbox channel

contact_identifierstringrequired

The source id of contact obtained on contact create

Responses

200

Success

idinteger

Id of the contact

source_idstring

The session identifier of the contact

namestring

Name of the contact when available

emailstring

Email of the contact

phone_numberstring

Phone number of the contact

pubsub_tokenstring

The token to be used to connect to texa-desk websocket

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

The given contact does not exist

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl 'https://desk.texadesk.com/public/api/v1/inboxes/aBcD3fGh1jKlMn0p/contacts/xYz9'

import os, requests

headers = {}
r = requests.get("https://desk.texadesk.com/public/api/v1/inboxes/aBcD3fGh1jKlMn0p/contacts/xYz9", headers=headers)
r.raise_for_status()
print(r.json())

const r = await fetch("https://desk.texadesk.com/public/api/v1/inboxes/aBcD3fGh1jKlMn0p/contacts/xYz9", {
  method: "GET",
});
if (!r.ok) throw new Error(`${r.status}: ${await r.text()}`);
console.log(await r.json());

Response 200

{
  "id": 1,
  "source_id": "string",
  "name": "string",
  "email": "string",
  "phone_number": "string",
  "pubsub_token": "string"
}