---
title: REST API
description: "Programmatic access to a Jira site's Mria CRM data under the path `/v1`: leads, contacts, companies, deals, products, their activities, links and custom fields, plus reference data and metrics. **Browse every endpoint in the [interactive API reference](https://mriacrm.com/api-reference/)**, with parameters, request…"
url: "https://mriacrm.com/docs/rest-api/"
updated: "2026-11-18"
category: REST API
---

# REST API

Programmatic access to a Jira site's Mria CRM data under the path `/v1`: leads, contacts, companies, deals, products, their activities, links and custom fields, plus reference data and metrics.

**Browse every endpoint in the [interactive API reference](https://mriacrm.com/api-reference/)**, with parameters, request bodies and response schemas.

Authentication is Atlassian OAuth 2.0 (3LO). There are no API keys. Every call runs on behalf of a real Atlassian user, with that user's CRM permissions.

## Setup and reference

- [Setup](/docs/rest-api-setup/). Enable the API and create the 3LO integration.
- [Authorization with curl](/docs/rest-api-authorization-with-curl/). The 3LO handshake as plain HTTP, with the errors.
- [Reference](/docs/rest-api-openapi/). Every endpoint, searchable, plus the OpenAPI spec to download.
- [Example Postman](/docs/rest-api-example-postman/). Import the spec and call the API.
- [Example Node.js](/docs/rest-api-example-node-js/). The same flow in one file of code.
- [Paging, Filters, Errors and Limits](/docs/rest-api-paging-filters-errors-and-limits/). How lists page and filter, the error envelope, the sizes and rates.
- [Attaching Files](/docs/rest-api-attaching-files/). Upload, list, download and delete the files on a record.

## Extended list responses

List endpoints can return **full record details** rather than a trimmed summary, and records now carry their **created** and **updated** timestamps.

This is what makes incremental syncing practical: with an updated timestamp on every record you can pull only what has changed since your last run, instead of re-reading the whole collection and diffing it yourself. It also means a single list call can populate a downstream system without a follow-up request per record.

The [OpenAPI](/docs/rest-api-openapi/) spec is the authoritative reference for exactly which fields each endpoint returns and how to request the extended form. Check it against the version deployed on your site — the API is actively developed, so shapes can change.

## Files

Files can be attached to Leads, Deals, Contacts and Companies, listed, downloaded and deleted — the same files as the record's Files tab. An upload is three calls: start, send the bytes to a one-time URL, confirm. See [REST API: Attaching Files](/docs/rest-api-attaching-files/).

## Company and Contact types

`GET /v1/recordTypes?entity=COMPANY` (or `CONTACT`) lists a type list in display order; on the Companies list the first type carries `isDefault`. Companies and Contacts return their `type` — a Contact also says whether it is inherited from its Company — take a `typeId` when created, and can be searched by `typeIds`. See [Company & Contact Types](/docs/company-and-contact-types/).

## How-to guides

Complete, worked integrations built on the API. Each one stands on its own and names the setup it needs.

- [Zapier: Lead Capture](/docs/rest-api-zapier-lead-capture/). A web form submission becomes a Lead in Mria CRM.
- [Zapier: Mailchimp Emails to Notes](/docs/rest-api-zapier-mailchimp-emails-to-notes/). An email campaign is logged as a note on each matching contact.
- [Migrating Activity History from Salesforce](/docs/rest-api-migrating-activity-history-from-salesforce/). Calls, emails, meetings, tasks and notes are written to the migrated records, with a sample script.
- [Getting Mria CRM Data into Power BI](/docs/rest-api-power-bi/). A scheduled, read-only export feeds a Power BI model, with the export script and a template.

## AI clients

For ChatGPT, Claude or another AI assistant, you do not need the REST API: Mria CRM also exposes an MCP server that Atlassian hosts, switched on per site by an Atlassian admin and used under each person's own CRM permissions. See [Mria CRM MCP server](/docs/mcp-server/).

## References

- [Accessing a Forge app's REST APIs](https://developer.atlassian.com/platform/forge/access-rest-apis-exposed-by-a-forge-app/)
- [OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/)
- [Implementing OAuth 2.0 (3LO)](https://developer.atlassian.com/cloud/oauth/getting-started/implementing-oauth-3lo/)

This API is supported and actively developed, so it can change without notice. It builds on Atlassian's Forge App REST APIs (Preview). Send feedback to the Mria CRM team.

  [https://www.addtoany.com/add_to/facebook?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API](https://www.addtoany.com/add_to/facebook?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API)[https://www.addtoany.com/add_to/x?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API](https://www.addtoany.com/add_to/x?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API)[https://www.addtoany.com/add_to/linkedin?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API](https://www.addtoany.com/add_to/linkedin?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api%2F&linkname=REST%20API)
