Contacts

Get one workspace contact

Returns a single workspace contact identified by canonical Telegram user id.

get/v1/contacts/{contact_id}

Request

  • Base URL: https://api.entergram.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.entergram.com/v1/contacts/{contact_id}
  • Auth: API key in header X-API-Key

Path parameters

contact_idstring required

Canonical Telegram user identifier for the contact.

Example:1000009876

Response

OK

Example response

{
  "data": {
    "bio": "Synthetic example contact for API documentation.",
    "firstName": "Alex",
    "isPremium": true,
    "knownByAccounts": [
      {
        "accountId": "acct_demo_123",
        "displayName": "Ops Sample",
        "ownerDisplayName": "Alex Example",
        "ownerUserId": "user_demo_123",
        "username": "ops_sample"
      }
    ],
    "lastName": "Example",
    "sharedGroupCount": 3,
    "sharedGroups": [
      {
        "chatType": "group",
        "displayName": "Community Alpha",
        "groupId": "-1000001234567",
        "inviteLink": "https://t.me/+sampleinvite123",
        "memberCount": 245,
        "participantCount": 245,
        "username": "samplecommunity"
      }
    ],
    "telegramUserId": "1000009876",
    "totalSharedGroupCount": 3,
    "username": "alex_example"
  }
}

Changes

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