> ## Documentation Index
> Fetch the complete documentation index at: https://developers.heymarket.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search contacts

> Search contacts by channel value, such as phone number or email address.

Use this endpoint when you know a channel value and need the matching contact.


## OpenAPI

````yaml api-reference/openapi/heymarket-openapi-3.1.2.yaml POST /v2/contacts/search
openapi: 3.1.2
info:
  contact:
    email: help@heymarket.com
    name: API Support
    url: https://heymarket.com
  description: >
    Welcome to Heymarket’s API! Many users access Heymarket via the web app,
    mobile apps, or one of the out-of-the-box platform integrations.

    However, much of Heymarket’s functionality can also be accessed via the API.

    The flexibility and scalability of the API makes it an excellent choice for
    integrating Heymarket into existing applications.


    This documentation provides details on: available authentication methods,
    endpoints that are available and error message information.


    If you want to get right to the action, download the collection to start
    performing calls from Postman or other similar software.


    All valid HTTP request and response bodies are encoded in JSON. For security
    purposes API requests must be made over HTTPS. Calls made over plain HTTP or
    without authentication will fail.


    Base URL: https://api.heymarket.com


    # Rate Limit

    The Heymarket API has a rate limit of 500 requests per minute. Exceeding the
    rate limit will result in responses with a 429 status code.


    # Request IDs

    Each API request has an associated request identifier. You can find this
    value in the response headers, under `X-Request-Id`.

    If you need to contact us about a specific request, providing the request
    identifier will ensure the fastest possible resolution.


    # Webhooks

    You can read more about [getting started with
    webhooks](https://help.heymarket.com/hc/en-us/articles/4416494130701-Getting-Started-with-Webhooks)
    from our articles collection.


    # Additional Admin APIs
        For more information about additional Admin APIs, please contact us at <help@heymarket.com>.
  license:
    name: Heymarket
    url: https://heymarket.com/legal
  termsOfService: https://heymarket.com/tos
  title: Heymarket API
  version: '1.0'
servers:
  - url: https://api.heymarket.com
security: []
tags:
  - name: Inboxes
    description: >
      The `Inbox` object represents a read only view of the team's inbox(es) in
      Heymarket.


      Any API requests that deal with message sending or scheduling will require
      an inbox ID as a parameter.


      #### The Inbox object


      | Attributes |
      Description                                                           |

      | ---------- |
      --------------------------------------------------------------------- |

      | `id`       | Unique identifier for the
      object                                      |

      | `name`    | Name of the
      inbox                                                     |

      | `team`     | Unique identifier for your
      team                                        |

      | `members`  | Unique identifier for your team members who have access to
      the inbox |

      | `phones`   | Heymarket phone number(s) associated with the
      inbox                    |
  - name: Users
    description: >
      The `User` object represents a team user in Heymarket.


      #### The User object


      | Attributes         |
      Description                                                   |

      | ------------------ |
      ------------------------------------------------------------- |

      | `id`               | Unique identifier for the
      object                              |

      | `name`             | Name of the
      user                                              |

      | `email`            | Email address of the
      user                                     |

      | `phone`            | Phone number of the
      user                                      |

      | `role_id`          | Unique identifier of the role of the user within
      the team     |

      | `team_id`          | Unique identifier for the team the user belongs
      to            |

      | `created_at`       | Creation date of the team
      user                                |

      | `updated_at`       | Last updated date of the team
      user                            |

      | `user_created_at`  | Creation date of the base
      user                                |

      | `user_updated_at`  | Last updated date of the base
      user                            |
  - name: User Groups
    description: >
      The `User Group` object represents a named group of team users in
      Heymarket.


      Groups are created and their membership managed in the Heymarket web app.
      They are used to

      scope objects such as lists and templates, and to address several
      teammates at once.


      #### The User Group object


      | Attributes    |
      Description                                                        |

      | ------------- |
      ------------------------------------------------------------------ |

      | `id`          | Unique identifier for the
      object                                   |

      | `name`        | Name of the
      group                                                  |

      | `description` | Description of the group. Omitted when the group has
      none          |

      | `member_ids`  | Unique identifiers of the group's
      members                          |

      | `members`     | The group's members, as `User`
      objects                             |
  - name: Team
    description: >
      The `Team` object represents a read only view of the team in Heymarket.


      #### The Team object


      | Attributes |
      Description                                                           |

      | ---------- |
      --------------------------------------------------------------------- |

      | `id`       | Unique identifier for the
      object                                      |

      | `name`    | Name of the
      team                                                     |

      | `list_size` | List size limit

      | `members`  | Unique identifiers for the users who have access to the
      team as well as their role within the team|
  - name: Contacts
    description: >
      The `Contact` object is a Heymarket contact. The contacts in Heymarket are
      used for storing information such as name, phone number, and email
      address. Contacts also store custom fields which can be used for search,
      list creation, and merge tokens while sending messages.


      #### The Contact object


      | Attributes         |
      Description                                                               
      |

      | ------------------ |
      --------------------------------------------------------------------------
      |

      | `id`               | Unique identifier for the
      object                                           |

      | `display_name`     | Display name, usually a combination of first and
      last name                 |

      | `first`            | First
      name                                                                 |

      | `last`             | Last
      name                                                                  |

      | `email`            | Email
      address                                                              |

      | `phone`            | Phone
      number                                                               |

      | `custom`           | Custom fields with value if present, only lists
      contact field ID and value |

      | `team_id`          | Unique identifier for your Heymarket
      team                                  |

      | `creator_id`       | Unique identifier for the user who created the
      contact, same as the member ID returned by Get
      Inboxes                        |

      | `shared`           | Boolean value for whether the contact is shared
      with team members          |

      | `created`          | Creation
      date                                                              |

      | `updated`          | Last updated
      date                                                          |

      | `rev`              | Last revision
      number                                                       |

      | `op`               | Operation
      performed                                                        |

      | `assigned_user_id` | Contact Owner
      ID                                                           |

      | `tags`             | Array of up to 5 `tag_id`
      objects                                                         |

      | `is_opted_out`     | Is this contact opted out of
      messaging?                                    |
  - name: Conversations
    description: The `Conversation` object represents a messaging thread in Heymarket.
  - name: Lists
    description: >
      The `List` object in Heymarket is used for organizing multiple phone
      numbers. You can send a single message to a list, the contacts will never
      see each other and can reply privately. Lists are also used as a source of
      contacts for your campaigns.


      #### The List object


      | Attributes   | Description                                         |

      | ------------ | --------------------------------------------------- |

      | `id`         | Unique identifier for the object                    |

      | `name`       | List name                                           |

      | `local_id`   | Client provided unique identifier for the object    |

      | `targets`    | Object containing multiple `ListTarget` objects     |

      | `team_id`    | Unique identifier for your Heymarket team            |

      | `creator_id` | Unique identifier for the user who created the list |

      | `shared`     | If the list is shared with team
      members                    |

      | `created`    | Creation date                                       |

      | `updated`    | Last updated date                                   |

      | `rev`        | Last revision number                                |

      | `op`         | Operation
      performed                                        |


      The `targets` object is a light weight representation of a contact.
      `phone` is used as a key and it has name fields as optional attributes
      which will be used as a merge token during message sending if there is no
      real Heymarket contact available for this phone number.


      #### The ListTarget object


      | Attributes | Description             |

      | ---------- | ----------------------- |

      | `f`        | First name (if available) |

      | `l`        | Last name (if available)  |
  - name: Templates
    description: >
      The `Template` object in Heymarket is a pre-defined message with text and
      media. Templates can also contain merge tokens which will insert the
      appropriate custom field values when sending the message. The main body of
      the template is stored in the `content` attribute.


      #### The Template object


      | Attributes   | Description                                         |

      | ------------ | --------------------------------------------------- |

      | `id`         | Unique identifier for the object                    |

      | `name`       | Template name                                       |

      | `local_id`   | Client provided unique identifier for the object    |

      | `content`    | Object representing template content                |

      | `team_id`    | Unique identifier for your Heymarket team            |

      | `creator_id` | Unique identifier for the user who created the template,
      same as the member ID returned by Get Inboxes |

      | `shared`     | If the template is shared with team
      members                |

      | `created`    | Creation date                                       |

      | `updated`    | Last updated date                                   |

      | `rev`        | Last revision number                                |

      | `op`         | Operation
      performed                                        |


      #### The Content object


      | Attributes | Description                     |

      | ---------- | ------------------------------- |

      | `text`     | Message text                    |

      | `gallery`  | Array of `GalleryEntry` objects |
  - name: Messages
    description: >
      The `Messages` API is a powerful Heymarket feature. With it you can send
      messages to individual contacts or a list of contacts.

      It has all the features of Heymarket's native clients, including sending
      messages from a template, sending media, and inserting merge tokens.
  - name: Schedule
    description: >-
      With the `Scheduling` API you can schedule a message to be sent to an
      individual contact or to a list.
  - name: Surveys
    description: >-
      Ask your customers a set of standardized questions to quickly understand
      their experience with your company.
  - name: Tags
    description: |
      The `Tag` object in Heymarket.
      #### The Tag object
      | Attributes   | Description                                         |
      | ------------ | --------------------------------------------------- |
      | `id`         | Unique identifier for the object                    |
      | `tag`        | Tag name                                            |
      | `color`      | Color                                               |
      | `team_id`    | Unique identifier for your Heymarket team           |
      | `created`    | Creation date                                       |
      | `updated`    | Last updated date                                   |
      | `rev`        | Last revision number                                |
  - name: Links
    description: >
      The `Link` object represents a tracked short URL owned by your team.


      Link tracking must be enabled for your team to use these endpoints.
      Requests from teams without the

      link tracking feature return `403` with the message
      `link_tracking_not_available`.


      All link operations are scoped to the team identified by your API
      credentials — links belonging to

      other teams cannot be read, updated, or deleted, and lookups for them
      return `404`.


      #### The Link object


      | Attributes | Description |

      | ---------- | ----------- |

      | `id` | Unique identifier for the object |

      | `short_code` | Code segment of the short URL |

      | `short_url` | Full short URL to include in messages |

      | `original_url` | Destination URL the short link redirects to |

      | `team_id` | Unique identifier for your team |

      | `target` | Target the link is attributed to (optional) |

      | `conversation_id` | Conversation the link is attributed to (optional) |

      | `broadcast_id` | Broadcast the link is attributed to (optional) |

      | `campaign_step_id` | Campaign step the link is attributed to (optional)
      |

      | `template_id` | Template the link is attributed to (optional) |

      | `last_visited_at` | Timestamp of the most recent click (optional) |

      | `created_at` | Creation date |
  - name: Webhooks
    description: Events Heymarket sends to webhook URLs configured for a team.
paths:
  /v2/contacts/search:
    post:
      tags:
        - Contacts
      summary: Search Contacts (V2)
      description: >
        Search contacts by channel value (phone, email, etc.) or by a structured
        filter grammar.

        `contact_channels` and `filters` are mutually exclusive search modes;
        supplying both is

        rejected with `contact_channels_and_filters`.


        #### Request body attributes


        | Attribute | Description |

        | --- | --- |

        | `contact_channels` | **array (required unless `filters` is set)** <br>
        One or more channel entries to search by. Each entry requires
        `channel_ids`. `channel_type` is optional — if omitted, the type is
        inferred from the ID format (E.164 → phone, email format → email, etc.).
        |

        | `contact_channels[].channel_type` | **string (optional)** <br> Channel
        type to search within (e.g. `phone`, `email`, `facebook`). |

        | `contact_channels[].channel_ids` | **array (required)** <br> List of
        channel values to look up. |

        | `filters` | **object (required unless `contact_channels` is set)**
        <br> Structured filter grammar: `{"match": "all"\|"any", "conditions":
        [...], "timezone": "<IANA zone>"}`. `match` defaults to `all` (AND);
        `any` ORs the listed conditions. `timezone` is the zone the date
        operators resolve against; omitted resolves in UTC. Each condition is
        either a leaf `{"field", "op", plus an operand}` or a nested group
        `{"match", "conditions": [...]}` of leaves only — groups cannot contain
        groups. At most 10 leaf conditions total. `field` is one of the thirteen
        core fields — `name` (display
        name)/`first_name`/`last_name`/`phone`/`email` (text), `date_added`
        (date), `assigned_user` (numeric user id), `opt_out_status`
        (`active`/`opt_out`/`bounced`/`blocked`), `sms_status`
        (`subscribed`/`opt_out`/`blocked`), `email_status`
        (`subscribed`/`unsubscribed`/`bounced`), `sentiment` (the backend's
        sentiment keys, e.g. `very happy`), `tag` — or `custom:<field id or
        name>` for a custom contact field, whose legal operators depend on its
        type (text/number/date). Operand shape: `is_empty`/`is_not_empty` take
        nothing; `between`/`not_between` take `gte`+`lte`; `in`/`not_in` take
        `ids` on `assigned_user` or `values` on
        text/`opt_out_status`/`sms_status`/`email_status`/`sentiment`;
        `has`/`has_all`/`not_has` on `tag` take `values` (a single `value` is
        also accepted); every other operator takes a single `value`.
        `sms_status` and `email_status` accept only `eq`/`neq`/`in`/`not_in`;
        `subscribed` requires the channel (a phone, an email), `email_status`
        `unsubscribed` is membership of any email suppression group, and a
        contact can hold several values at once, so `in` matches any and
        `not_in` none. Any negative operator (`neq`, `not_contains`, `not_in`,
        `not_on`, `not_between`, `not_has`) matches valueless contacts by
        default; set `include_empty: false` on that condition to exclude them.
        Every other operator except `is_empty`/`is_not_empty` matches only
        contacts with a value; set `include_empty: true` to also match valueless
        ones (rejected with `include_empty_not_supported` on `date_added`,
        `opt_out_status`, `sms_status` and `email_status`, which every contact
        has a value for). A `list` field condition is rejected with
        `list_filter_not_supported`: this endpoint authenticates a team-level
        API credential, not a user, so it has no caller to scope list visibility
        against.  This endpoint returns at most the first page of matches (100
        by default) and exposes no paging: `total` counts every match and
        `truncated` is set when more matched than were returned, or when a
        filter condition matched more contacts than the resolver caps (the
        result is then partial).|


        #### Example filters request body

        ```json
            {
              "filters": {"match": "all", "conditions": [
                {"field": "custom:state", "op": "eq", "value": "CA"},
                {"field": "assigned_user", "op": "is_empty"}
              ]}
            }
        ```
      operationId: v2SearchContacts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/doc.V2ContactSearchReq'
        description: Search parameters
        required: true
      responses:
        '200':
          description: >
            Matching contacts. A `contact_channels` search returns a bare array
            of contacts.

            A `filters` search returns an object carrying `contacts`, `total`
            (the full match

            count, not the size of the returned page) and `resolved_filters`
            (the filter set

            the search ran, with custom-field references resolved to their
            titles, relative

            dates resolved to the date or instant each compares against and the
            `timezone`

            that applied).
          content:
            application/json:
              schema:
                oneOf:
                  - items:
                      $ref: '#/components/schemas/doc.Contact'
                    type: array
                  - type: object
                    properties:
                      contacts:
                        items:
                          $ref: '#/components/schemas/doc.Contact'
                        type: array
                      total:
                        type: integer
                        format: int64
                      resolved_filters:
                        type: object
                      truncated:
                        type: boolean
                        description: >-
                          set when the result is missing matches — more matched
                          than were returned, or a filter condition exceeded its
                          resolve cap
        '400':
          description: >-
            bad_data (legacy channel search), or a filters validation error —
            contact_channels_and_filters, too_many_conditions, nesting_too_deep,
            unknown_operator, operator_not_legal_for_field_type, unknown_match,
            unknown_field, ambiguous_field, empty_filter_set,
            invalid_filter_value, filter_result_truncated,
            contains_value_too_short, exact_value_too_long,
            list_filter_not_supported, include_empty_not_supported,
            filters_disabled (the filters grammar is not enabled yet). Custom
            date fields hold calendar dates; `timezone` applies to date_added
            and to the relative operators on custom date fields
          content:
            application/json:
              schema:
                oneOf:
                  - type: string
                  - $ref: '#/components/schemas/doc.V2ErrorResp'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
        default:
          $ref: '#/components/responses/DefaultServerError'
      security:
        - ApiSecretJwtAuth: []
        - LegacyApiKeyAuth: []
components:
  schemas:
    doc.V2ContactSearchReq:
      type: object
      description: >
        Exactly one of `contact_channels` or `filters` must be supplied; sending
        both is

        rejected with `contact_channels_and_filters`.
      properties:
        contact_channels:
          type: array
          description: >
            One or more channel entries to search by. Each entry specifies the
            channel type and a list of IDs to match.

            If `channel_type` is omitted, the type is inferred from the ID
            format (e.g. E.164 phone → phone, email format → email).
          items:
            type: object
            required:
              - channel_ids
            properties:
              channel_type:
                type: string
                description: >-
                  Channel type to search within (e.g. phone, email, facebook).
                  Omit to auto-detect from ID format.
                example: phone
              channel_ids:
                type: array
                description: List of channel values to search for.
                items:
                  type: string
                example:
                  - '14155551234'
                  - '14155559876'
        filters:
          $ref: '#/components/schemas/doc.FilterSet'
    doc.Contact:
      properties:
        avatar:
          type: string
        inbox_opt_outs:
          description: >-
            Per-inbox opt-out breakdown, present on contact reads when the
            number has inbox-scoped opt-out rows. Omitted for contacts with no
            scoped rows.
          type: array
          items:
            $ref: '#/components/schemas/doc.InboxOptOut'
        created:
          type: string
        creator_id:
          type: integer
        custom:
          type: object
        display_name:
          type: string
        email:
          type: string
        external_id:
          type: string
        external_ref:
          type: string
        first:
          type: string
        id:
          type: integer
        inbox_id:
          type: integer
        last:
          type: string
        note:
          items:
            $ref: '#/components/schemas/doc.ContactNote'
          type: array
        op:
          type: string
        parent_id:
          type: integer
        phone:
          type: string
        rev:
          type: integer
        shared:
          type: boolean
        team_id:
          type: integer
        type:
          type: string
        updated:
          type: string
        assigned_user_id:
          type: integer
        tags:
          type: array
          items: {}
      type: object
    doc.V2ErrorResp:
      type: object
      required:
        - error
        - details
      properties:
        error:
          type: string
          description: Machine-readable snake_case error code. Branch on this field.
          example: invalid_filter
        details:
          type: string
          description: >-
            Human-readable explanation of the failure. Do not parse; it may
            change without notice.
          example: 'unsupported filter: name'
    doc.FilterSet:
      type: object
      required:
        - conditions
      properties:
        match:
          type: string
          description: '"all" (AND, default) or "any" (OR).'
          example: all
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/doc.FilterCondition'
        timezone:
          type: string
          description: >-
            IANA zone the date operators (on/before/after/between/
            within_last/within_next/more_than_ago) resolve against. Omitted
            resolves in UTC.
          example: America/Los_Angeles
    doc.InboxOptOut:
      description: >-
        A single inbox-scoped opt-out entry. Only teams using per-inbox opt-out
        accumulate these rows.
      properties:
        inbox_id:
          description: The inbox the contact/number is opted out of.
          type: integer
          example: 2
        set_from_contact:
          description: >-
            True if the contact opted themselves out (e.g. replied STOP).
            False/absent = the opt-out was set by an agent or the API.
          type: boolean
          example: false
      type: object
    doc.ContactNote:
      properties:
        date:
          type: string
        id:
          type: string
        name:
          type: string
        text:
          type: string
        user_id:
          type: integer
      type: object
    doc.FilterCondition:
      type: object
      properties:
        field:
          type: string
          description: >-
            One of the thirteen core fields — "name" (display name),
            "first_name", "last_name", "phone", "email" (text), "date_added"
            (date), "assigned_user" (numeric user id), "opt_out_status" (one of
            active/opt_out/bounced/blocked), "sms_status" (one of
            subscribed/opt_out/blocked), "email_status" (one of
            subscribed/unsubscribed/bounced), "sentiment" (one of the backend's
            sentiment keys, e.g. "very happy"), "tag" — or "custom:<field id or
            name>" for a custom contact field, whose legal operators depend on
            its type (text/number/date). "list" is accepted by the grammar but
            always rejected here with list_filter_not_supported, since this
            endpoint authenticates a team-level API credential with no caller to
            scope list visibility against.
          example: assigned_user
        op:
          type: string
          description: >
            Operator; the legal set is closed per field kind. text (name,
            first_name,

            last_name, phone, email, text custom fields): eq, neq, contains,

            not_contains, starts_with, in,

            not_in, is_empty, is_not_empty. number (numeric custom fields): eq,
            neq, gt,

            gte, lt, lte, between, not_between, is_empty, is_not_empty. date

            (date_added, date custom fields): on, not_on, before, on_or_before,
            after,

            on_or_after, between, not_between, within_last, within_next,
            more_than_ago,

            is_empty, is_not_empty. opt_out_status, sentiment and assigned_user:
            eq,

            neq, in, not_in, is_empty, is_not_empty. sms_status and
            email_status: eq,

            neq, in, not_in. tag: has, has_all, not_has, is_empty, is_not_empty.
          example: is_empty
        value:
          type: string
          description: >-
            Single-value operand, used by most operators except is_empty,
            is_not_empty, between, not_between, in, and not_in.
        values:
          type: array
          items:
            type: string
          description: >-
            Multi-value operand for in/not_in on text and pick (opt_out_status,
            sms_status, email_status, sentiment) fields, and for
            has/has_all/not_has on tag (a single value is also accepted via
            `value`).
        gte:
          type: string
          description: Lower bound, used only with the between and not_between operators.
        lte:
          type: string
          description: Upper bound, used only with the between and not_between operators.
        ids:
          type: array
          items:
            type: integer
          description: >-
            ID list, used only by in/not_in on the list and assigned_user
            fields.
        include_empty:
          type: boolean
          description: >-
            On a negative operator (neq, not_contains, not_in, not_on,
            not_between, not_has), valueless contacts are included unless this
            is false. On any other operator except is_empty/is_not_empty they
            are excluded unless this is true; true is rejected with
            include_empty_not_supported on date_added, opt_out_status,
            sms_status and email_status, which every contact has a value for.
            Ignored by is_empty/is_not_empty.
        match:
          type: string
          description: >-
            Present only on a nested group ("all" or "any"), never alongside
            field/op.
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/doc.FilterCondition'
          description: >-
            Present only on a nested group of leaf conditions; groups cannot
            contain groups.
  responses:
    UnauthorizedError:
      description: Authentication credentials were missing or invalid.
      content:
        text/plain:
          schema:
            type: string
          examples:
            response:
              value: Unauthorized
    TooManyRequestsError:
      description: The request exceeded the API rate limit.
      content:
        text/plain:
          schema:
            type: string
          examples:
            response:
              value: too many requests
    DefaultServerError:
      description: Unexpected server error.
      content:
        text/plain:
          schema:
            type: string
          examples:
            response:
              value: error
  securitySchemes:
    ApiSecretJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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:


        ```json

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

        ```


        ```text

        {
          "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:


        ```text

        YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

        ```


        Send the signed JWT as a bearer token:


        ```text

        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.
    LegacyApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: Team API key
      description: >-
        Legacy authentication for existing integrations. Provide the Heymarket
        team API key as a bearer token in the `Authorization` header.


        ```text

        Authorization: Bearer YOUR_API_KEY

        ```


        API key authentication is planned for deprecation. New integrations
        should use API Secret JWT authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.