List interest categorys

GET/api/v1/interest-categories
Requires anorganization API keywith the scopecontacts:read

Request

GET/api/v1/interest-categories
curl -X GET 'https://app.mailyte.com/api/v1/interest-categories' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataarray<object>
    • objectstringinterest_category
    • idstring
    • titlestring

      The question, as a contact reads it on a signup form — usually phrased as one: "What do you want to hear about?"

    • typestringcheckboxes | dropdown | radio | hidden

      How the group renders on a form. THIS IS PRESENTATION, NOT ENFORCEMENT: a `radio` group with two interests selected is a form that was bypassed, not a rejected write, because refusing it would lose data we already hold rather than fix the form. `hidden` keeps the group off the form entirely so it can only be set through the API, which is how an internal classification lives beside the ones a contact chooses.

    • display_orderinteger

      Position on the form, lower first.

    • interestsarray<object>

      The answers a contact can choose. Returned WITH the category because they are read as one thing — a form section — and fetching them separately would be two round trips to render one block of checkboxes. `null` means UNKNOWN: the relation was not loaded, never that the category has no answers.

      • idstring
      • namestring
      • display_orderinteger
    • created_atstring

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.