Skip to main content
GET
/
v1
/
team
Get Team
curl --request GET \
  --url https://api.heymarket.com/v1/team \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "list_size": 123,
  "members": [
    {
      "id": 123,
      "name": "<string>",
      "role": "<string>"
    }
  ]
}
Use this endpoint to inspect team metadata and member IDs.

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.

Response

Team Object

​
id
integer
​
name
string
​
list_size
integer
​
members
object[]