API
API documentation
Jira users who have access to Atlas CRM have access to the Atlas CRM API. You can find the detailed API documentation in Jira in the Atlas CRM menu. Please go here to find template information and exact endpoint urls.
Template information
You will need the unique ID's of the fields that are present in your templates to create and update companies/contacts/sales. You can find this information by clicking on 'template information'.
Pagination
The API uses pagination to limit the response size for resources that return a potentially large collection of items. The API will return an items
array wrapped in a JSON object with paging metadata. For example:
items
- the list of items.total
- total number of hits.links
- relevant links, including a self reference under theself
key and optionally anext
key. If there is anext
field it is the url to the next page.
If you want to get 10 more items you can call the url found in next
and from that response you can call next
again. When there are no more items there won't be any next
key in the JSON object.
Entity endpoints
Retrieve entities
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities
You can use this endpoint to fetch Atlas CRM entities (companies, contacts and sales). You can filter entities by field values with query parameters. Query parameters follow this format:
field-id=field-value
ba8e058c-17b5-4c1c-9215-f73fefd66dba=Avisi
You can find the ID's of your fields in your template information.
Query Parameters
Name | Type | Description |
---|---|---|
cursor | string | See pagination |
type | string | Filter entities to be only of this type. Valid values are "sale", "company" and "contact" |
limit | integer | Amount of entities to retrieve from 1 to 1000. Default: 100 |
Create a new entity
POST
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities
Create a company, contact or sale.
Request Body
Name | Type | Description |
---|---|---|
fields | object | Fields object should contain field ID's as keys.
|
type | string | "sale", "company" or "contact" |
Find entity by ID
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Retrieve a company, contact or sale.
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact or sale. |
Update existing entity
PUT
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Update an existing company, contact or sale
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact or sale. |
Request Body
Name | Type | Description |
---|---|---|
fields | string | Fields object should contain field ID's as keys.
|
Delete an existing entity
DELETE
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Delete a company, contact or sale.
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact or sale. |
Retrieve template information by entity type
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/template/{entity-type}
Using this endpoint, a template of an Atlas CRM entity (company, contact and sale) can be retrieved. On the page linked below we describe how to "Build your own Atlas CRM" form using this endpoint.
Path Parameters
Name | Type | Description |
---|---|---|
entity-type | string | Type of an Atlas CRM entity ("company", "contact" or "sale"). |
Find field information by ID
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/field/{field-id}
This endpoint finds a field of a template based on field ID and displays template information of that field.
Path Parameters
Name | Type | Description |
---|---|---|
field-id | string | ID of a field. |
Jira issues endpoints
Link Jira issues
POST
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/issues
Link Jira issues to a company, contact or sale
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact or sale. |
Request Body
Name | Type | Description |
---|---|---|
issue-ids | array | Array of integers containing issue ID's.
|
Unlink Jira issues
DELETE
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/issues
Removes links from Jira issues to company, contact or sale
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact or sale. |
Request Body
Name | Type | Description |
---|---|---|
issue-ids | array | Array of integers containing issue ID's.
|
Links between entities
Retrieve existing links
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links
You can filter linked entities by using their template fields.
For example: Find all linked contacts of a company (id = "5") that live in Germany.
Search for the country field in the contact template in your template information. The field ID equals "27". Your url will be as follows:
.../entities/5/links?type=contact&27=Germany
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact, or sale. |
Query Parameters
Name | Type | Description |
---|---|---|
cursor | string | See pagination |
type | string | "sale", "company" or "contact |
limit | integer | Amount of entities to retrieve from 1 to 1000. Default: 100 |
Create a new link
POST
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links
Create a link between two existing entities.
Path Parameters
Name | Type | Description |
---|---|---|
entity-id | string | An ID of a company, contact, or sale. |
Request Body
Name | Type | Description |
---|---|---|
roles | array | An array of strings containing information about this link. For example a contact can have roles |
id | string | An ID of a company, contact, or sale |
Retrieve link information
GET
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}
Path Parameters
Name | Type | Description |
---|---|---|
other-entity-id | string | An ID of a company, contact, or sale. |
entity-id | string | An ID of a company, contact, or sale. |
Update link information
PUT
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}
Path Parameters
Name | Type | Description |
---|---|---|
other-entity-id | string | An ID of a company, contact, or sale. |
entity-id | string | An ID of a company, contact, or sale. |
Request Body
Name | Type | Description |
---|---|---|
roles | array | An array of strings containing information about this link. For example a contact van have roles |
Delete a link
DELETE
https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}
Path Parameters
Name | Type | Description |
---|---|---|
other-entity-id | string | An ID of a company, contact, or sale. |
entity-id | string | An ID of a company, contact, or sale. |
If you have feedback about the API or if you need help, please contact us in our service desk.
Last updated