Get contact channel - Heymarket API Documentation

{ "id": 123, "team_id": 123, "contact_id": 123, "channel_type": "<string>", "channel_id": "<string>", "info_channel": "<string>", "channel_handle": "<string>", "created": "<string>", "updated": "<string>" }

Authorizations

Authorization

string

header

required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

{
  "alg": "HS256",
  "typ": "JWT"
}

{
  "iss": "YOUR_API_SECRET_ID",
  "iat": CURRENT_UNIX_TIMESTAMP
}

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

Send the signed JWT as a bearer token:

Authorization: Bearer YOUR_SIGNED_JWT

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Path Parameters

contactID

string

required

Contact UUID

channelType

string

required

Channel type (e.g. phone, email, facebook)

Response

Contact channel

integer

contact channel ID

team_id

integer

team for contact channel

contact_id

integer

contact id

channel_type

string

channel type (e.g. phone, email, facebook)

channel_id

string

value for the channel type (phone number, email address, etc.)

info_channel

string

related integration channel

channel_handle

string

handle related to channel

created

string

created time

updated

string

updated time