Contacts

List workspace contacts

Returns workspace contacts deduplicated across connected accounts, including knownByAccounts attribution and merged shared-group metadata.

get/v1/contacts

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
  • Auth: API key in header X-API-Key

Query parameters

limitinteger

Number of contacts to return per page.

Example:50
offsetinteger

Zero-based offset for pagination.

searchstring

Case-insensitive search over Telegram user id, names, username, and bio.

Example:alex
member_idstring

Optional filter for contacts known by a specific workspace member id.

Example:user_demo_123
account_idstring

Optional filter for contacts known by a specific connected account id.

Example:acct_demo_123

Response

OK

Example response

{
  "data": {
    "items": [
      {
        "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.