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:
1
{
2
"items": [...],
3
"total": 10,
4
"_links": {
5
"self": {
6
"href": "/jira/rest/atlascrm/api/1.0/workspaces/CRM/entities?cursor=zxcxz"
7
},
8
"next": {
9
"href": "/jira/rest/atlascrm/api/1.0/workspaces/CRM/entities?cursor=fdsfh535sfdsfd"
10
}
11
}
12
}
Copied!
  • items - the list of items.
  • total - total number of hits.
  • links - relevant links, including a self reference under the self key and optionally a next key. If there is a next 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

get
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/entities
Retrieve entities
post
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/entities
Create a new entity
get
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Find entity by ID
put
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Update existing entity
delete
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}
Delete an existing entity
get
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/template/{entity-type}
Retrieve template information by entity type
get
https://myjira.com
/rest/atlascrm/api/1.0/workspaces/CRM/field/{field-id}
Find field information by ID

Jira issues endpoints

If you have feedback about the API or if you need help, please contact us in our service desk.

Last modified 7mo ago