> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theomnibot.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Contact by Identifier: ID, Email, or Phone
> Use GET /api/v1/contacts/{identifier} to retrieve a single contact from your ChatbotX Workspace by internal ID, email address, or phone number.
The Get Contact endpoint retrieves a single contact record by a flexible identifier. You can look up any contact using their internal ChatbotX ID, their email address, or their phone number — all with the same endpoint. The response includes the full contact object with profile fields, tags, custom fields, notes, inbox connections, and the most recent conversation.
**GET** `/api/v1/contacts/{identifier}`
## Path Parameters
A contact lookup string using one of the three supported prefix formats. Minimum length: 1 character.
| Format | Example |
| --------------- | ------------------------ |
| `id:` | `id:123456789` |
| `email:` | `email:user@example.com` |
| `phone:` | `phone:+84708123123` |
## Code Examples
```bash curl theme={null}
# Look up by email
curl --request GET \
--url "https://app.chatbotx.io/api/v1/contacts/email:user@example.com" \
--header "Authorization: Bearer YOUR_API_TOKEN"
# Look up by phone
curl --request GET \
--url "https://app.chatbotx.io/api/v1/contacts/phone:+84708123123" \
--header "Authorization: Bearer YOUR_API_TOKEN"
# Look up by internal ID
curl --request GET \
--url "https://app.chatbotx.io/api/v1/contacts/id:123456789" \
--header "Authorization: Bearer YOUR_API_TOKEN"
```
```python Python theme={null}
import requests
identifier = "email:user@example.com"
url = f"https://app.chatbotx.io/api/v1/contacts/{identifier}"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
response = requests.get(url, headers=headers)
print(response.json())
```
```javascript JavaScript theme={null}
const identifier = 'email:user@example.com';
const options = {
method: 'GET',
headers: { Authorization: 'Bearer YOUR_API_TOKEN' }
};
fetch(`https://app.chatbotx.io/api/v1/contacts/${identifier}`, options)
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error(err));
```
## Response Fields
Unique contact ID.
Timestamp when the contact was created.
Timestamp of the last update.
URL of the contact's profile image.
Contact's phone number.
Contact's email address.
Whether the email has been verified.
Whether the contact opted in to email communications.
Contact's first name.
Contact's last name.
Computed full name.
One of `male`, `female`, `unknown`.
When the contact last read a message.
External reference identifier.
Contact's country.
Contact's state or region.
Contact's city.
Contact's locale string.
Contact's timezone.
When the contact subscribed.
When the contact subscribed to broadcasts.
When blocked, or `null` if not blocked.
ID of the owning Workspace.
Custom field values for this contact.
Tags applied to this contact.
Notes attached to this contact.
Active inbox connections for this contact.
Most recent conversation object, or `null`.
## Example Response
```json theme={null}
{
"id": "clx1abc123",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2024-01-15T10:22:00Z",
"avatar": null,
"phoneNumber": "+84708123123",
"email": "user@example.com",
"emailVerified": true,
"emailOptIn": true,
"firstName": "Jane",
"lastName": "Doe",
"fullName": "Jane Doe",
"gender": "female",
"lastReadAt": "2024-01-14T08:00:00Z",
"ref": null,
"country": "VN",
"state": null,
"city": "Ho Chi Minh City",
"location": null,
"locale": "vi-VN",
"timezone": "Asia/Ho_Chi_Minh",
"subscribedAt": "2023-11-07T05:31:56Z",
"broadcastSubscribedAt": "2023-11-07T05:31:56Z",
"blockedAt": null,
"workspaceId": "ws123",
"contactCustomFields": [
{
"id": "cf1",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"value": "premium",
"contactId": "clx1abc123",
"customFieldId": "field1"
}
],
"tags": [
{
"id": "tag1",
"name": "VIP",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceId": "ws123"
}
],
"contactNotes": [],
"contactInboxes": [],
"conversation": null
}
```