Skip to main content
POST
List User Groups
Use this endpoint to find the id of each user group in your team and see which team members belong to it. Send an empty JSON body ({}) to return every group. To return specific groups only, pass their IDs in group_ids. Pass a group id in add_group_ids or remove_group_ids of POST /v1/inbox/update_members to give a group access to an inbox or take it away.

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:

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:

Send the signed JWT as a bearer token:

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.

Body

application/json
group_ids
integer[]

Response

user groups in a team, each with its members

user_groups
object[]