# Relm CRM REST API

**Canonical:** https://apis.io/apis/relmcrm-com/relm-crm-rest-api/  
**Provider:** Relm — https://apis.io/providers/relmcrm-com/  
**Base URL:** https://api.relmcrm.com/v1  
**Documentation:** https://relmcrm.com/docs

Relm CRM REST API is one of 3 APIs that [Relm](https://apis.io/providers/relmcrm-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include CRM, Sales, Contacts, Deals, and Sales Pipeline. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

REST surface for the whole Relm workspace — contacts, companies, deals, activities (full CRUD with soft delete + restore), pipelines and stages, custom fields / enum values / object types, automations, drip sequences, templates, BYO messaging connections, webhooks with signed deliveries, cross-object search, a 100-operation batch endpoint, usage and spend-cap settings, and a live self-describing GET /schema. 72 operations across 41 paths, OpenAPI 3.1.0, servers[] https://api.relmcrm.com/v1. Bearer key or OAuth 2.1; RFC 9457 errors; keyset cursor pagination; Idempotency-Key on the four core creates; If-Match on updates.

## Operations (60 of 72)

| Method | Path | Summary |
|---|---|---|
| GET | `/schema` | Live object/field/enum registry. |
| GET | `/usage` | Current billing period usage. |
| GET | `/settings` | Workspace settings (spend cap). |
| PATCH | `/settings` | Set the monthly overage spend cap. |
| GET | `/search` | Cross-object search over contacts, companies and deals. |
| GET | `/enums` | All enum groups and their values. |
| POST | `/enums` | Add a value to an enum group (idempotent). |
| POST | `/fields` | Register a custom field on an object. |
| POST | `/types` | Register a custom object type (schema grouping only). |
| GET | `/contacts` | List contacts. |
| POST | `/contacts` | Create a contact. |
| GET | `/contacts/{id}` | Fetch a contact. |
| PATCH | `/contacts/{id}` | Update a contact. |
| DELETE | `/contacts/{id}` | Soft-delete a contact. |
| POST | `/contacts/{id}/restore` | Restore a soft-deleted contact. |
| GET | `/companies` | List companies. |
| POST | `/companies` | Create a company (name required). |
| GET | `/companies/{id}` | Fetch a company. |
| PATCH | `/companies/{id}` | Update a company. |
| DELETE | `/companies/{id}` | Soft-delete a company. |
| POST | `/companies/{id}/restore` | Restore a company. |
| GET | `/deals` | List deals. |
| POST | `/deals` | Create a deal (title required). |
| GET | `/deals/{id}` | Fetch a deal. |
| PATCH | `/deals/{id}` | Update a deal (incl. moving stage/pipeline). |
| DELETE | `/deals/{id}` | Soft-delete a deal. |
| POST | `/deals/{id}/restore` | Restore a deal. |
| GET | `/activities` | List activities. |
| POST | `/activities` | Log an activity (attach to a contact and/or deal). |
| GET | `/activities/{id}` | Fetch an activity. |
| PATCH | `/activities/{id}` | Update an activity. |
| DELETE | `/activities/{id}` | Soft-delete an activity. |
| POST | `/activities/{id}/restore` | Restore an activity. |
| GET | `/pipelines` | List pipelines with their ordered stages. |
| POST | `/pipelines` | Create a pipeline. |
| GET | `/pipelines/{key}` | Fetch a pipeline. |
| PATCH | `/pipelines/{key}` | Update a pipeline: display `name`, `is_default`, and/or re-`key` it. The key is slugified; deals attach by internal id, so a re-key never orphans them. A sof... |
| DELETE | `/pipelines/{key}` | Delete a pipeline (fails if deals still use it). |
| POST | `/pipelines/{key}/default` | Make this pipeline the workspace default. |
| POST | `/pipelines/{key}/stages` | Add a stage to a pipeline. |
| POST | `/pipelines/{key}/stages/reorder` | Reorder stages (order = a permutation of every existing stage key). |
| PATCH | `/pipelines/{key}/stages/{stage}` | Rename/retype a stage. `key` is slugified; deals on the stage follow automatically (linked by internal id), so this safely fixes a typo'd key or sets the sem... |
| DELETE | `/pipelines/{key}/stages/{stage}` | Delete a stage (fails if deals use it). |
| GET | `/automations` | List automations. |
| POST | `/automations` | Create a single-step rule: when <trigger_event> [if <conditions>] then <actions>. |
| GET | `/automations/{id}` | Fetch an automation. |
| PATCH | `/automations/{id}` | Enable or disable an automation (only `enabled` is patchable). |
| DELETE | `/automations/{id}` | Delete an automation. |
| GET | `/automations-capabilities` | Valid trigger events, condition ops, action types and channels. |
| GET | `/sequences` | List drip sequences with steps and enrollment counts. |
| POST | `/sequences` | Create a multi-step drip sequence. |
| GET | `/sequences/{id}` | Fetch a sequence. |
| PATCH | `/sequences/{id}` | Enable or disable a sequence (only `enabled` is patchable). |
| DELETE | `/sequences/{id}` | Delete a sequence. |
| GET | `/sequences/{id}/preview` | Dry-run: who would enroll now + the send schedule. |
| GET | `/sequences/{id}/enrollments` | List enrollments and their state. |
| POST | `/sequences/{id}/enroll` | Manually enroll a contact (idempotent per contact+sequence). |
| GET | `/templates` | List email templates. |
| POST | `/templates` | Create a reusable email template. |
| GET | `/templates/{id}` | Fetch a template. |

…and 12 more operations. They are listed in full on the page.

## Machine-readable artifacts (14)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/openapi/relmcrm-com-openapi.yml
- **OpenAPI** — https://relmcrm.com/openapi.json
- **Documentation** — https://relmcrm.com/docs
- **APIReference** — https://relmcrm.com/docs
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/conventions/relmcrm-com-conventions.yml
- **Idempotency** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/conventions/relmcrm-com-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/errors/relmcrm-com-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/data-model/relmcrm-com-data-model.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/overlays/relmcrm-com-openapi-overlay.yaml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/asyncapi/relmcrm-com-webhooks.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/sandbox/relmcrm-com-sandbox.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/rate-limits/relmcrm-com-rate-limits.yml
- **SDKs** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/packages/relmcrm-com-packages.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/relmcrm-com/refs/heads/main/apis.yml

## Other Relm APIs (2)

- [Relm MCP Server](https://apis.io/apis/relmcrm-com/relm-mcp-server/)
- [Relm A2A Agent](https://apis.io/apis/relmcrm-com/relm-a2a-agent/)

## Tags

CRM, Sales, Contacts, Deals, Sales Pipeline, Automation, Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/relmcrm-com/relm-crm-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/relmcrm-com/.