Contacts

Get a contact

Requires read_only. Returns the contact with distinct conversationIds and channels, oldest first. Unknown or out-of-scope ids return 404 contactNotFound. Counters start when Contacts ships; history is not backfilled.

get/v1/contacts/{contactId}

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/contacts/{contactId}
  • Auth: HTTP bearer

Path parameters

contactIdstring required

Contact owning this channel.

Example:jd7contact123

Response

Get a contact.

Example response

{
  "contact": {
    "id": "jd7contact123",
    "profileId": "jd7profile123",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "company": "Acme",
    "avatarUrl": "https://images.example.com/jane.jpg",
    "tags": [
      "VIP",
      "Lead"
    ],
    "isSubscribed": true,
    "isBlocked": false,
    "notes": "Interested in the launch.",
    "customFields": {
      "leadScore": 42,
      "customer": true
    },
    "messagesSentCount": 3,
    "messagesReceivedCount": 5,
    "lastMessageSentAt": "2026-09-19T12:00:00.000Z",
    "lastMessageReceivedAt": "2026-09-19T12:00:00.000Z",
    "source": "api",
    "createdAt": "2026-09-19T12:00:00.000Z",
    "updatedAt": "2026-09-19T12:00:00.000Z",
    "conversationIds": [
      "t_12345"
    ]
  },
  "channels": [
    {
      "id": "jd7channel123",
      "contactId": "jd7contact123",
      "accountId": "jd7account123",
      "platform": "instagram",
      "platformIdentifier": "178414000001",
      "displayIdentifier": "@jane",
      "isSubscribed": true,
      "conversationId": "t_12345",
      "metadata": {
        "locale": "en"
      },
      "lastActiveAt": "2026-09-19T12:00:00.000Z",
      "createdAt": "2026-09-19T12:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.