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": [...],
  "total": 10,
  "_links": {
    "self": {
      "href": "/jira/rest/atlascrm/api/1.0/workspaces/CRM/entities?cursor=zxcxz"
    },
    "next": {
      "href": "/jira/rest/atlascrm/api/1.0/workspaces/CRM/entities?cursor=fdsfh535sfdsfd"
    }
  }
}
  • 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

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

{"total": 2,
 "items": [{"id": "4007444d-b9e3-44f2-8459-043fa99b5844",
            "type": "company",
            "fields": {"bbc5b474-6354-4f95-9f07-32f29bf2a9c1": "Avisi"},
            "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844"},
                       "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u4007444d-b9e3-44f2-8459-043fa99b5844%22%5D"}}},
            
            {"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
             "type": "contact",
             "fields": {"1cf3d940-e028-4209-ab23-840d0e1fcaf5": "Timo"},
             "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/3d99e9c0-6055-4721-974e-1db2174e50f1"},
                        "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u3d99e9c0-6055-4721-974e-1db2174e50f1%22%5D"}}}],
 "_links": {"self": {"href" : "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities"}}}

Create a new entity

POST https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities

Create a company, contact or sale.

Request Body

{"id": "4007444d-b9e3-44f2-8459-043fa99b5844",
 "type": "company",
 "fields": {"bbc5b474-6354-4f95-9f07-32f29bf2a9c1": "John Doe"},
 "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844"},
                     "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u4007444d-b9e3-44f2-8459-043fa99b5844%22%5D"}}}

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

{"id": "4007444d-b9e3-44f2-8459-043fa99b5844",
 "type": "company",
 "fields": {"bbc5b474-6354-4f95-9f07-32f29bf2a9c1": "John Doe"},
 "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844"},
                     "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u4007444d-b9e3-44f2-8459-043fa99b5844%22%5D"}}}

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

Request Body

{"id": "4007444d-b9e3-44f2-8459-043fa99b5844",
 "type": "company",
 "fields": {"bbc5b474-6354-4f95-9f07-32f29bf2a9c1": "John Doe",
            "dfsc5b44-6d54-4ff5-9f07-werd9bf2asfd": "j.doe@gmail.com"},
 "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844"},
                     "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u4007444d-b9e3-44f2-8459-043fa99b5844%22%5D"}}}

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

{"id": "4007444d-b9e3-44f2-8459-043fa99b5844",
 "type": "company",
 "fields": {"bbc5b474-6354-4f95-9f07-32f29bf2a9c1": "John Doe"},
 "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844"},
                     "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u4007444d-b9e3-44f2-8459-043fa99b5844%22%5D"}}}

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

{
    "entity-type": "sale",
    "sections": [
        {
            "id": "a711faad-e858-402f-a8e0-33b54955e8eb",
            "name": "Main information",
            "fields": [
                {
                    "id": "fdc57351-69a3-4afa-9578-b8295fa2805c",
                    "label": "Name",
                    "type": "string",
                    "isa": "other",
                    "required?": true,
                    "read-only?": false
                    "_links": {
                        "self": {
                            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/field/<field-id>"
                        }
                    }
                },
                {
                    "id": "370ae779-51c9-4e5e-974f-c1c929289775",
                    "label": "Funnel stage",
                    "type": "single-select",
                    "isa": "other",
                    "required?": false,
                    "read-only?": false,
                    "_links": {
                        "self": {
                            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/field/<field-id>"
                        }
                    }
                    "options": [
                        {
                            "id": "e506608f-be10-4ec3-9350-905677045f74",
                            "label": "Lead"
                        },
                        {
                            "id": "30c1d1b2-748c-47b7-b504-0474bfbbcc69",
                            "label": "Opportunity"
                        },
                        {
                            "id": "844140f9-6ce7-4d4b-9703-c0aa0f108fde",
                            "label": "Contract"
                        }
                    ]
                }
            ]
        },
        {
            "id": "f7eff527-bbb8-4431-8444-9b1abd998d55",
            "name": "Financial",
            "fields": [
                {
                    "id": "512ddcbe-41ad-4dd8-8611-489187de0ba1",
                    "label": "Estimated revenue",
                    "type": "decimal",
                    "isa": "currency",
                    "required?": false,
                    "read-only?": false,
                    "config": {
                            "atlas-crm/currency": "USD"
                    },
                    "_links": {
                        "self": {
                            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/field/<field-id>"
                        }
                    }
                },
                {
                    "id": "60a99a24-0c89-4041-afc8-afb80795d793",
                    "label": "Estimated probability",
                    "type": "decimal",
                    "isa": "percentage",
                    "required?": false,
                    "read-only?": false,
                    "config": {
                        "decimal/max": 100,
                        "decimal/min": 0
                    }
                    "_links": {
                        "self": {
                            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/field/<field-id>"
                        }
                    }
                }
            ]
        }
    ],
    "_links": {
        "self": {
            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/template/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

{
    "id": "370ae779-51c9-4e5e-974f-c1c929289775",
    "label": "Funnel stage",
    "type": "single-select",
    "isa": "other",
    "required?": false,
    "read-only?": false,
    "_links": {
        "self": {
            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/field/<field-id>"
        },
        "template": {
            "href": "https://myjira.com/atlascrm/api/1.0/workspaces/CRM/template/sale"
        }
    },
    "options": [
        {
            "id": "e506608f-be10-4ec3-9350-905677045f74",
            "label": "Lead"
        },
        {
            "id": "30c1d1b2-748c-47b7-b504-0474bfbbcc69",
            "label": "Opportunity"
        }, 
        {
            "id": "844140f9-6ce7-4d4b-9703-c0aa0f108fde",
            "label": "Contract"
        }
    ]
}

Jira issues endpoints

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

Request Body

{"issue-ids": [1023, 1230, 1394]}

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

Request Body

{"issue-ids": [1023, 1230, 1394]}

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

Query Parameters

{"total": 1,
 "items": [{"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
            "type": "contact",
            "fields": {"1cf3d940-e028-4209-ab23-840d0e1fcaf5": "Timo"},
            "_links": {"self": {"href": "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/3d99e9c0-6055-4721-974e-1db2174e50f1"},
                       "callcenter": {"href": "https://myjira.com/secure/atlascrm/callcenter?entity-id=%5B%22~%23%27%22%2C%22~u3d99e9c0-6055-4721-974e-1db2174e50f1%22%5D"}}}],
 "_links": {"self": {"href" : "https://myjira.com/plugins/servlet/atlascrm/api/1.0/workspaces/CRM/entities/4007444d-b9e3-44f2-8459-043fa99b5844/links"}}}

POST https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links

Create a link between two existing entities.

Path Parameters

Request Body

{"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
 "type": "contact",
 "roles": ["CEO"]}

GET https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}

Path Parameters

{"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
 "type": "contact",
 "roles": ["CEO"]}

PUT https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}

Path Parameters

Request Body

{"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
 "type": "contact",
 "roles": ["CTO"]}

DELETE https://myjira.com/rest/atlascrm/api/1.0/workspaces/CRM/entities/{entity-id}/links/{other-entity-id}

Path Parameters

{"id": "3d99e9c0-6055-4721-974e-1db2174e50f1",
 "type": "contact",
 "roles": ["CTO"]}

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

Last updated