> ## 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.

# Heymarket API

> Use the Heymarket REST API to send messages, manage contacts, organize conversations, and connect Heymarket with your own systems.

The Heymarket API lets you build customer messaging workflows on top of the same inboxes, contacts, conversations, lists, and templates your team uses in Heymarket.

<CardGroup cols={2}>
  <Card title="Read the overview" icon="book-open" href="/introduction">
    Learn how the API is organized and what you can build with it.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Create an API Secret and generate signed JWTs.
  </Card>

  <Card title="Send a message" icon="message" href="/guides/send-message">
    Follow the first-message guide after you have an inbox ID and sender ID.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference/contacts/overview">
    Browse endpoint details for contacts, messages, conversations, and more.
  </Card>
</CardGroup>

## Quick start

You need a Heymarket account and an API Secret before making API calls.

<Steps>
  <Step title="Create an API Secret">
    Log in to [Heymarket](https://app.heymarket.com) and go to **Settings > Integrations > API** to generate an API Secret.
  </Step>

  <Step title="Generate a signed JWT">
    Follow the [authentication guide](/authentication) to generate a short-lived JWT from your API Secret ID and Secret Key.
  </Step>

  <Step title="Authenticate requests">
    Pass your signed JWT as a Bearer token in every request:

    ```text theme={null}
    Authorization: Bearer YOUR_SIGNED_JWT
    ```
  </Step>

  <Step title="Confirm access">
    Call `GET /v1/inboxes` to verify authentication and find the inbox IDs available to your team.

    ```bash theme={null}
    curl https://api.heymarket.com/v1/inboxes \
      -H "Authorization: Bearer YOUR_SIGNED_JWT"
    ```
  </Step>

  <Step title="Send a message">
    Use an inbox ID and sender member ID from your account when sending a message.

    ```bash theme={null}
    curl -X POST https://api.heymarket.com/v1/message/send \
      -H "Authorization: Bearer YOUR_SIGNED_JWT" \
      -H "Content-Type: application/json" \
      -d '{
        "inbox_id": 42,
        "creator_id": 7,
        "phone_number": "14155551234",
        "text": "Hello from the Heymarket API!"
      }'
    ```
  </Step>

  <Step title="Keep building">
    Browse the [API Reference](/api-reference/contacts/overview) to discover contacts, conversations, lists, templates, and more.
  </Step>
</Steps>

## Product links

<CardGroup cols={2}>
  <Card title="Sign in" icon="key" href="https://app.heymarket.com">
    Open Heymarket to get credentials, inbox IDs, and team member IDs.
  </Card>

  <Card title="Book a demo" icon="calendar" href="https://www.heymarket.com/demo/">
    Talk with Heymarket about your messaging use case.
  </Card>

  <Card title="Visit the website" icon="globe" href="https://www.heymarket.com/">
    Learn more about Heymarket products, integrations, and pricing.
  </Card>

  <Card title="Contact sales" icon="message" href="https://www.heymarket.com/contact-sales/">
    Ask about plans, availability, and account setup.
  </Card>
</CardGroup>
