canonical: https://jentic.com/apis/gmelius.com/gmelius # Gmelius API Gmelius layers shared inboxes, Trello-style boards, email sequences, and team collaboration on top of Gmail. The Gmelius API exposes that workspace programmatically: applications can create and manage boards, columns, and cards; track conversations and shared folders; run email sequences; and register webhooks. OAuth-issued bearer tokens drive most calls, with basic auth available for the token-exchange endpoint, so the API fits both first-party automations and OAuth-based integrations. ## For AI agents Manage Gmelius shared-inbox boards, cards, conversations, sequences, and webhooks alongside a Gmail-native collaboration workspace. ## Scope Does not send raw Gmail messages, host video calls, or run a CRM pipeline - use for Gmelius shared-inbox boards, cards, conversations, sequences, and webhooks only. ## Capabilities - Create a Gmelius board with named columns to drive a kanban view of shared-inbox work - Move a card between columns or assign tags via PATCH `/auth/boards/cards/{id}` - List boards, columns, and the cards inside a column to power a custom workspace dashboard - Manage shared folders that group conversations across the team - Register a webhook so external systems are notified when a card or conversation changes - Exchange an OAuth authorization code for an access token via POST /token ## Use cases ### Shared-Inbox Kanban Automation Support and ops teams using Gmelius for shared inboxes can drive their kanban workflow through the API: incoming conversations create cards in a Triage column via POST `/auth/boards/columns/{id}/cards`, automations move cards to In-Progress on first reply, and Done columns archive resolved work. The API exposes both boards and columns so the layout can be programmed rather than configured manually. Setup is typically half a day. Example prompt: POST `/auth/boards/columns/{id}/cards` with a title and conversationId, then PATCH `/auth/boards/cards/{id}` when the conversation status changes. ### Cross-Team Reporting Dashboard Managers want a single dashboard that summarises board activity across the company: open cards per column, average time-in-stage, and tag distribution. Listing `/auth/boards`, then `/auth/boards/{id}/columns`, then `/auth/boards/columns/{id}/cards` yields the data, and a daily aggregation feeds a BI tool. The data shape is stable enough to support trending without needing scraping. Example prompt: Loop over `/auth/boards`, then for each board read `/auth/boards/{id}/columns` and `/auth/boards/columns/{id}/cards`, and aggregate counts per column. ### Webhook-Driven Downstream Notifications Teams that already run an internal Slack or queue can register a Gmelius webhook to mirror card and conversation changes outbound. The `/auth/webhooks` endpoints (covered in the Webhooks tag) let an integration subscribe to events, then transform and forward them to other tools without polling the API. This avoids missing changes when teams are heads-down. Example prompt: Register a webhook against the Gmelius API with the destination URL, then transform inbound payloads to the downstream Slack message format. ### AI Triage Across Shared Inboxes An AI assistant reading shared-inbox conversations through Jentic can categorise incoming threads and create or move Gmelius cards accordingly. With a single Jentic search the agent can load the right card-creation schema and avoid writing direct HTTP code against the 36-endpoint Gmelius surface. Example prompt: Search Jentic for 'create gmelius card', load the schema for POST `/auth/boards/columns/{id}/cards`, and create a card in the Triage column. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/auth/boards` | List boards | | POST | `/auth/boards` | Create a board | | GET | `/auth/boards/{id}/columns` | List columns in a board | | POST | `/auth/boards/columns/{id}/cards` | Create a card in a column | | PATCH | `/auth/boards/cards/{id}` | Update a card | | DELETE | `/auth/boards/cards/{id}` | Delete a card | | POST | `/token` | Exchange authorization code for tokens | ## Key resources - **Boards** — Top-level kanban boards that group columns and cards. - **Columns** — Stages within a board with their own card lists. - **Cards** — Individual work items, optionally linked to conversations and tagged. - **Conversations** — Email threads tracked through Gmelius shared inboxes. - **Sequences** — Outbound email sequence configuration. - **Webhooks** — Subscribe to Gmelius events for outbound automation. - **Authentication** — OAuth token exchange and current-user lookup. ## Why Jentic - **Setup:** Wiring Gmelius by hand means learning both its bearer and basic auth, exchanging tokens, and mapping its 36-endpoint board and card surface yourself. Through Jentic you install once, import the Gmelius API from the API Directory, store the credential once, and your agent calls it. - **Permission scoping:** Gmelius puts the board id in the URL path (`/auth/boards/{id}/columns`), so a rule can pin your agent to one board: it can read and create cards there and nothing else. You choose the operations it may call, so destructive ones like deleting a card are not included unless you add them. - **Credential handling:** Your Gmelius OAuth client secret and bearer token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a Gmelius card' or 'list boards', and Jentic returns the matching Gmelius operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **Help Scout API** — Standalone shared-inbox helpdesk versus Gmelius's Gmail-native overlay. - **Missive API** — Team email and chat with a similar shared-inbox model and a smaller surface. - **HubSpot CRM Contacts** — CRM that pairs with Gmelius when shared-inbox cards need to be linked to known contacts. ## FAQ ### What authentication does the Gmelius API use? Gmelius uses OAuth-issued bearer tokens for most endpoints (Authorization: Bearer {token}) plus HTTP basic auth on the POST /token endpoint that exchanges an authorization code for tokens. Through Jentic both credentials sit in the vault and are injected per call. ### Can I create and update kanban cards through the Gmelius API? Yes. POST `/auth/boards/columns/{id}/cards` creates a card in a column and PATCH `/auth/boards/cards/{id}` updates it. Cards can carry tags via POST `/auth/boards/cards/{id}/tags` and be deleted via DELETE `/auth/boards/cards/{id}.` ### What are the rate limits for the Gmelius API? Gmelius does not publish a fixed per-second rate limit in the OpenAPI spec; back off on HTTP 429 responses. Webhooks (registered via the `/auth/webhooks` endpoints) are the recommended pattern for high-frequency change tracking instead of polling. ### How do I list a board's columns and cards through Jentic? Search Jentic for 'list gmelius columns' and 'list gmelius cards', load the schemas for GET `/auth/boards/{id}/columns` and GET `/auth/boards/columns/{id}/cards`, and execute them in sequence. Run pip install jentic first. ### Does Gmelius support webhooks for card events? Yes. The Webhooks tag in the OpenAPI spec covers webhook registration so external systems are notified when cards or conversations change, replacing the need to poll `/auth/boards/columns/{id}/cards.` ### Is the Gmelius API free to use? API access typically follows the Gmelius workspace plan rather than being billed per call. Check your team's Gmelius subscription tier - higher tiers expose more board, sequence, and webhook quotas. ### Can I limit what my agent is allowed to do with the Gmelius API? Yes. Because you run Jentic One yourself, your own rules decide which Gmelius operations and credentials the agent may use. Since Gmelius carries the board id in the URL path, such as `/auth/boards/{id}/columns`, a rule can pin the agent to a single board so it only reads and creates cards there. You choose the operations it may call, so destructive ones like DELETE `/auth/boards/cards/{id}` stay off the list unless you add them.