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:
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.
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
Fields object should contain field ID's as keys.
{"bbc5b474-635...." : "John Doe"}
Values for date fields should be in format yyyy-mm-dd where mm and dd are optional. "2019-12-31"
1{"message": "Sale opened-at date can not be in the future"}or2{"schema": {"type":"(enum \"sale\" \"company\" \"contact\")","fields":"(schema {Uuid (maybe (either (constrained Str \"non blank string\") Uuid Inst Num))})" },"errors": {"fields":"(not (map? nil))" },"type": "reitit.coercion/request-coercion","coercion": "schema","value": {"fields":null,"type":"sale" },
{"message": "Unexpected exception","exception": "clojure.lang.ExceptionInfo: Can not find user for user-key","uri": "/api/1.0/workspaces/CRM/entities"}
Fields object should contain field ID's as keys.
{"bbc5b474-635...." : "John Doe"}
Values for date fields should be in format yyyy-mm-dd where mm and dd are optional. "2019-12-31"
Use null as value if you want to remove values for fields.
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").
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
