---
title: "REST API: Setup"
description: "## Enable the API `admin.atlassian.com` → **Apps** → **Sites** → your site → **Connected apps** → **Mria CRM** → **View app details** → **Details** → **App REST APIs** → **Enable**. It is off by default. Copy the **Base URL** shown…"
url: "https://mriacrm.com/docs/rest-api-setup/"
updated: "2026-11-18"
category: REST API
---

# REST API: Setup

## Enable the API

`admin.atlassian.com` → **Apps** → **Sites** → your site → **Connected apps** → **Mria CRM** → **View app details** → **Details** → **App REST APIs** → **Enable**. It is off by default.

Copy the **Base URL** shown there. The first UUID in it is your `cloudId`.

## Add the 3LO integration

1. [Developer console](https://developer.atlassian.com/console/myapps/) → **Create** → **OAuth 2.0 integration**. Give the integration a name, pick the **Access type** and accept the developer terms. **Account-level** lets one Client ID reach every site in your organization, so a client authorized once works on a dev and a production site. **Resource-level** ties it to the single site the user picks at authorization. Both work with Mria CRM; pick Account-level unless the client must be limited to one site.
   [![REST API: Setup: Add the 3LO integration](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-01.png)](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-01.png)
2. **Permissions** → **Add Marketplace or custom app** → your site → **Mria CRM** → `read:crm:custom`, `write:crm:custom` and `read:profile:custom`.
3. **Permissions** → **Jira API** → **Configure** → `read:forge-app:jira`.
   [![REST API: Setup: Add the 3LO integration](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-02.png)](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-02.png)
4. **Authorization** → add the callback URLs of the clients you will use, matched exactly. Use `https://oauth.pstmn.io/v1/callback` for the Postman desktop app, `https://oauth.pstmn.io/v1/browser-callback` for the Postman web app, and `http://localhost:3000/oauth/callback` for the Node.js example.
   [![REST API: Setup: Add the 3LO integration](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-03.png)](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-03.png)
5. **Settings** → copy the Client ID and Client secret.
   [![REST API: Setup: Add the 3LO integration](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-04.png)](https://mriacrm.com/wp-content/uploads/2026/11/rest-api-setup-04.png)

**Scopes the clients actually request**
`read:profile:custom` is what lets a client call `GET /me`, which is the first request in both the Postman collection and the Node.js example. Without it, consent succeeds and the first call returns 403.
`offline_access` is not ticked in the developer console. A client adds it to the scope parameter of the authorize URL when it wants a refresh token; the Node.js example does, and Postman's collection does when you use it. Refresh tokens rotate on every use, so a client must always keep the newest one.

To run the authorization yourself, request by request, see [REST API: Authorization with curl](/docs/rest-api-authorization-with-curl/).

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-setup%2F&linkname=REST%20API%3A%20Setup](https://www.addtoany.com/add_to/facebook?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api-setup%2F&linkname=REST%20API%3A%20Setup)[https://www.addtoany.com/add_to/x?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api-setup%2F&linkname=REST%20API%3A%20Setup](https://www.addtoany.com/add_to/x?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api-setup%2F&linkname=REST%20API%3A%20Setup)[https://www.addtoany.com/add_to/linkedin?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api-setup%2F&linkname=REST%20API%3A%20Setup](https://www.addtoany.com/add_to/linkedin?linkurl=https%3A%2F%2Fmriacrm.com%2Fdocs%2Frest-api-setup%2F&linkname=REST%20API%3A%20Setup)
