###Authentication : This is HTTPS-only API. Authentication will be performed based on the email address of the user and the respective API Key.
Email and API key should pass HTTP Basic Authentication. (Use email address as username and the respective API Key as password)
###API Key
- You may access the API Key from Admin Settings -> API & Analytics -> API Key
- Use the first one (API Key for REST client) for all the REST API calls.
![Finding API Key] (https://github.com/agilecrm/rest-api/blob/master/api/Agile_CRM_API_Key.png)
###Endpoints: All API requests should be made to: https://{domain}.agilecrm.com/dev/
Note: All the data is case-sensitive. Emails, names and other values are case sensitive. For example, "Test" and "test" are considered as two different words.
- Contacts & Companies API
| Field Name | Description | Value Type | Read-Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id is generated when contact is created | integer | Yes | Yes, to update and delete calls. | N/A |
| type | Type distinguishes a contact and a company. | string | No | No. | Defaults to "PERSON" if not mentioned."PERSON" or "COMPANY" |
| tags | Unique identifiers added to contact, for easy management of contacts. This is not applicable for companies. | list | no | no | Tag name should start with an alphabet and can not contain special characters other than underscore and space. |
| lead_score | Score of contact. This is not applicable for companies. | integer | no | no | Any positive integer |
| contact_company_id | This field should be added in the Contact object only, to specify that the contact is working in the given company. | Long | No | No | We should give the company id. It will accept long values only. |
| star_value | Rating of contact (Max value 5). This is not applicable for companies. | short | no | no | 0 to 5 |
| properties | Contact properties are represented by list of JSON objects, each JSON object should follow the prototype shown. Custom fields will have type as CUSTOM and others will have type as SYSTEM. | List of JSON objects | no | first_name is mandatory | |
| campaignStatus | Information about the campaigns ran on that contact like name, status, start time, end time of campaign | List of JSONObjects | Yes | Only if this contact has campaigns | N/A |
| unsubscribeStatus | Information about the campaign from which the contact is unsubscribed. | List of JSONObjects | Yes | Only if this contact has campaigns | N/A |
| emailBounceStatus | Information about the email bounce and spam while running the campaign | List of JOSNObjects | Yes | Only if this conatct has campaigns | N/A |
###Properties JSON:
| Field Name | Description | Value Type | Read-Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| name | Name of the field. | String | No | Yes | Any string |
| type | Type of the field (Whether it is system defined field or custom field). | String | No | Yes | SYSTEM or CUSTOM |
| subtype | Sub type of the field.Only SYSTEM properties like email will have the sybtypes. | String | No | No | The value of this field depends up on the property name. |
| value | Value of the property. | String | No | No | Any String. |
The below are the subtypes for respective property fields.
| Name | Type | Syb types |
|---|---|---|
| SYSTEM | work,personal | |
| phone | SYSTEM | work,home,mobile,main,home fax,work fax,other |
| address | SYSTEM | home,postal,office |
| website | SYSTEM | URL,SKYPE,TWITTER,LINKEDIN,FACEBOOK,XING,FEED,GOOGLE_PLUS,FLICKR,GITHUB,YOUTUBE |
Note: There will be subtypes for custom fields. User should specify the above mentioned subtype for those respective properties only.
###Contact JSON Example
{
"id": 27001,
"type": "PERSON",
"created_time": 1349974226,
"updated_time": 1364483386,
"star_value": 0,
"lead_score": 0,
"tags": [
"Buyer",
"Deal Closed"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Adam"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Smith"
},
{
"type": "SYSTEM",
"name": "company",
"value": "Invox"
},
{
"type": "SYSTEM",
"name": "title",
"value": "Evangelist"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "",
"value": "jagan@clickdesk.com"
},
{
"type": "CUSTOM",
"name": "My Custom Field",
"value": "Custom value"
}
],
"campaignStatus": [
{
"start_time": 1418204274,
"end_time": 1418204293,
"campaign_id": "5338160762454016",
"campaign_name": "Send Email",
"status": "5338160762454016-DONE"
}
],
"unsubscribeStatus": [
{
"campaign_id": "5338160762454016",
"unsubscribeType": "CURRENT"
}
],
"emailBounceStatus": [
{
"email": "hard_bounce@test.mandrillapp.com",
"emailBounceType": "HARD_BOUNCE",
"time": 1418204263,
"campaign_id": "5338160762454016"
}
],
"widget_properties": "{\"Twitter\":\"11458852\"}",
"domainUser": {
"id": 314001,
"domain": "mycompany",
"email": "crm-user@mycompany.com",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "angel",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1364879569,\"created_time\":1361958281}",
"hashedString": "81dc9bdb52d04dc20036dbd8313ed055"
}
}##1.1 Listing Contacts :
###dev/api/contacts
Method: GET
- returns list of contacts in domain which are ordered by creation time.
For the Response in the XML format, add the header 'Accept' as application/xml. By default, the response will be in XML format. Paging can be applied using the page_size and cursor query parameters. Count of the contacts will be in the first contact and Cursor for the next page will be in the last contact of the list. If there is no cursor, it means that it is the end of list.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts?page_size=20&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept : application/xml" -v -u {email}:{apikey}```
###Example XML response
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contacts>
<contact>
<id>40002</id>
<type>PERSON</type>
<created_time>1356589886</created_time>
<updated_time>1357107323</updated_time>
<star_value>0</star_value>
<lead_score>93</lead_score>
<tags>sales</tags>
<tags>bruik</tags>
<tags>walt</tags>
<tags>los</tags>
<tags>vo</tags>
<tags>steady</tags>
<properties>
<type>SYSTEM</type>
<name>first_name</name>
<value>Los </value>
</properties>
<properties>
<type>SYSTEM</type>
<name>last_name</name>
<value>Bruikheilmer</value>
</properties>
<properties>
<type>SYSTEM</type>
<name>company</name>
<value>steady.inc</value>
</properties>
<properties>
<type>SYSTEM</type>
<name>title</name>
<value>VP Sales</value>
</properties>
<properties>
<type>SYSTEM</type>
<name>email</name>
<subtype>work<subtype/>
<value>bruik@walt.inc</value>
</properties>
<properties>
<type>SYSTEM</type>
<name>address</name>
<value>{"address":"","city":"","state":"","zip":"","country":""}</value>
</properties>
<domainUser>
<id>106010</id>
<domain>yaswanth</domain>
<email>praveen@invox.com</email>
<is_admin>true</is_admin>
<is_account_owner>true</is_account_owner>
<is_disabled>false</is_disabled>
<name>yaswanth</name>
<password>PASSWORD</password>
<info_json_string>
{"logged_in_time":1359434638,"created_time":1358831084}
</info_json_string>
</domainUser>
</contact>
</contacts>For the Response in the JSON format, add the header 'Accept' as application/json.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts?page_size=20&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept : application/json"
-v -u {email}:{apikey}####Example JSON response
[
{
"count": "9",
"id": "40002",
"type": "PERSON",
"created_time": "1356589886",
"updated_time": "1357107323",
"star_value": "0",
"lead_score": "93",
"tags": [
"sales", "bruik", "walt", "los", "vo", "steady"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Los "
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Bruikheilmer"
},
{
"type": "SYSTEM",
"name": "company",
"value": "steady.inc"
},
{
"type": "SYSTEM",
"name": "title",
"value": "VP Sales"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "bruik@walt.inc"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"\"}"
}
],
"domainUser": {
"id": "106010",
"domain": "yaswanth",
"email": "praveen@invox.com",
"is_admin": "true",
"is_account_owner": "true",
"is_disabled": "false",
"name": "yaswanth",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1359434638,\"created_time\":1358831084}"
}
},
{
"id": "41002",
"type": "PERSON",
"created_time": "1356590542",
"updated_time": "1359367255",
"star_value": "4",
"lead_score": "92",
"tags": [
"president",
"john",
"doe",
"cruzzetech"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "John"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Doe"
},
{
"type": "SYSTEM",
"name": "company",
"value": "cruzzetech.com"
},
{
"type": "SYSTEM",
"name": "email",
"value": "john@cruzzetech.com"
},
{
"type": "SYSTEM",
"name": "title",
"value": "President"
}
],
"tags_with_time_json": "{\"president\":1359365229885,\"john\":1359365229885,\"doe\":1359365229885,\"cruzzetech\":1359365229885}",
"domainUser": {
"id": "106010",
"domain": "yaswanth",
"email": "praveen@invox.com",
"is_admin": "true",
"is_account_owner": "true",
"is_disabled": "false",
"name": "yaswanth",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1359434638,\"created_time\":1358831084}"
}
}
]###Other available Responses:
- Status 200: Gives the above JSON object in above format.
- Status 204: There are no contacts in your account.
- Status 401: Unauthorised (when the user name and password fields are wrong.)
##1.2 Get contact by id ###dev/api/contacts/{id} Method: GET
- Returns contact object which is associated with given id
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} -H "Accept :application/xml"
-v -u {email}:{apikey}###Example Response
- Returns created contact object with all parameters in it as mentioned in the above example.
###Other available Responses:
- Status 200: Gives the above JSON object in above format.
- Status 204: No contact with the specified ID in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##1.3 Creating a contact ###dev/api/contacts Method: POST
Accepts contact JSON as post data along with the credentials of domain User (User name and API Key).
###Acceptable request Representation:
{
"star_value": "4",
"lead_score": "92",
"tags": ["Lead","Likely Buyer"],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Los "
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Bruikheilmer"
},
{
"type": "SYSTEM",
"name": "company",
"value": "steady.inc"
},
{
"type": "SYSTEM",
"name": "title",
"value": "VP Sales"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "bruik@walt.inc"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"\"}"
},
{
"type": "CUSTOM",
"name": "My Custom Field",
"value": "Custom value"
}
]
}###Response:
- Status 200: Contact added successfully. Returns the newly added contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
- Status 406: If the limit of the contacts is exceeded.
##1.4 Updating contact ###dev/api/contacts Method: PUT
Accepts contact object with valid id parameter in it, where ‘id’ refers to the contact that is to be updated. While updating the contact, If that contact is having campaigns, we should include the fields emailBounceStatus, campaignStatus and unsubscribeStatus in the contact object (The data in these fields should be same as it is in the retrieved contact object).
###Acceptable request Representation:
{
"id":8573489754593
"star_value": "4",
"lead_score": "92",
"tags": ["Lead","Likely Buyer"],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Los "
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Bruikheilmer"
},
{
"type": "SYSTEM",
"name": "company",
"value": "steady.inc"
},
{
"type": "SYSTEM",
"name": "title",
"value": "VP Sales"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "bruik@walt.inc"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"\"}"
},
{
"type": "CUSTOM",
"name": "My Custom Field",
"value": "Custom value"
}
]
}If there is no ID, it will considered as a new contact.
###Response:
- Status 200: Contact updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
##1.5 Delete single contact ###dev/api/contacts/{id} Method: DELETE
- Deletes contact based on the id of the contact, which is sent in request url path.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} \
-v -u {email}:{apikey} -X DELETE###Response:
- Status 204: Contact deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##1.6 Search Contact by Email ###dev/api/contacts/search/email Method: POST
- Searches for the contact with given email address. Email address should be sent as a form parameter (Content-Type: application/x-www-form-urlencoded ). We can search for multiple contacts using their Email-Ids.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/search/email -H "Accept: application/xml"
-H "Content-Type :application/x-www-form-urlencoded"
-d ‘email_ids=["notifications@basecamp.com"]’
-v -u {email}:{apikey} -X POST###Response:
- Status 200: Gives the Contact as JSON object in the above format. If email doesn’t match, it will return an empty object.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the email is in wrong format.
##1.7 Adding Tags to a contact based on Email: ###dev/api/contacts/email/tags/add Method: POST
- Searches for the contact based on the given email address and adds the given tags to the contact. You can add multiple tags. Tags should be sent as an array. Email address (email) and tags (tags) array should be sent as a form parameter (Content-Type: application/x-www-form-urlencoded ).Tag name should start with an alphabet and can not contain special characters other than underscore and space.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/email/tags/add -H "Accept: application/xml"
-H "Content-Type :application/x-www-form-urlencoded"
-d ‘email=notifications@basecamp.com&tags=["testing"]’
-v -u {email}:{apikey} -X POST###Response:
- Status 204: Tags added successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
##1.8 Delete Tags to a contact based on Email: ###dev/api/contacts/email/tags/delete Method: POST
- Searches for the contact based on the given email address and searches for the given tag in the contact's tag list. If there is a match, then it deletes that tag. You can delete multiple tags. Tags should be sent as an array. Email address (email) and tags (tags) array should be sent as a form parameter(Content-Type: application/x-www-form-urlencoded )
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/email/tags/delete -H "Accept: application/xml"
-H "Content-Type :application/x-www-form-urlencoded"
-d ‘email=notifications@basecamp.com&tags=["testing"]’
-v -u {email}:{apikey} -X POST###Response:
- Status 204: Tags deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
##1.9 Add Score to a Contact using Email-ID: ###dev/api/contacts/add-score Method: POST
- It is used to change the score of the contact using the email address. If you want to decrease the existing score, then use negative values for the score parameter.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/add-score -H "Accept: application/xml" -H "Content-Type :application/x-www-form-urlencoded"
-d ‘email=notifications@basecamp.com&score=5’ -v -u {email}:{apikey} -X POST###Response:
- Status 200: Score changed successfully and it returns the Contact object.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##1.10 Get Tasks related to Contact: ###dev/api/contacts/{contact_id}/tasks/sort Method: GET
- Retrieves the tasks related to contact, sorted by the date (latest first.).
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/tasks/sort -H "Accept: application/xml" -v -u {email}:{apikey}###Response:
- Status 200: Returns the tasks list related to the contact.
[
{
"id": 5152971570544640,
"type": "EMAIL",
"priority_type": "NORMAL",
"due": 1409596200,
"created_time": 1409567774,
"is_complete": false,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
"created_time": 1403057154,
"updated_time": 1403057154,
"viewed_time": 0,
"viewed": {
"viewed_time": 1409567737463,
"viewer_id": 5345980119515136
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "email",
"value": "notifications@basecamp.com"
}
],
"campaign- Status": [],
"entity_type": "contact_entity",
"unsubscribe- Status": [],
"emailBounce- Status": [],
"owner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [],
"progress": 0,
"- Status": "YET_TO_START",
"ownerPic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
]- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##1.11 Updating contact properties ###dev/api/contacts/add/property Method: POST
We can update a single field of the contact using this call. It is used to add the new property or update the existing property. It accepts property object of contact with valid parameter in it. We need to send the Email-Id of the contact to identify it. This will not effect other fields.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/add/property?email=test@agile.com -H "Content-Type: application/json" -d '{\"type\" : \"SYSTEM\", \"name\" : \"first_name\", \"value\" : \"AgileTest\"}' 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST ###Acceptable request Representation:
{
"type": "SYSTEM",
"name": "first_name",
"value": "Los "
}If there is no ID, it will considered as a new contact.
###Response:
- Status 200: Contact updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
##1.12 Change contact owner ###dev/api/contacts/change-owner Method: POST
We can update the owner of the contact using this call. It will take two parameters. One is the email address of the user (owner_email) and the second one is the ID of the contact(contact_id). Both fields are mandatory.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/change-owner -H "Content-Type: application/x-www-form-urlencoded" -d 'owner_email=test@agilecrm.com&contact_id=5646748928180224' -V -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST ###Response:
- Status 200: Owner changed successfully. Returns the updated contact object in the response. If the user does not exists with the given email, it returns a message saying user does not exist with that email.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
- Deals API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted Values |
|---|---|---|---|---|---|
| id | Unique id is assigned to every deal, when it is created | integer | no | Yes, if request is to update an existing deal | N/A |
| name | Name of the deal | string | no | Yes | N/A |
| description | Brief description about deal. | string | no | No | N/A |
| expected_value | Estimated value of a deal. | long | no | Yes | Max up to 1000000000000 |
| pipeline_id | Track id of the deal. | long | no | Yes | There should be a track with this Id. |
| milestone | Milestone of deal (won, progress, lost..). These depend up on the track selected. Milestones may differ based on the tracks. | String | no | Yes | MIlestone in the above mentioned track. |
| probability | integer | no | should be ranging between 0-100 | 0 to 100 | |
| close_date | close date of deal | long | no | Yes | Epoch time |
| created_time | Created time of the deal. Returns time in seconds | long | yes | No, generated automatically on deal creation | Epoch time |
| owner_id | owner_id represents id of domain user | string | No, write access is provided to set owner of deal | Yes | The id of the user. |
| prefs | JSON string | N/A | |||
| contacts | Relates list of contacts to deal | List of contact. | Yes | No | |
| contact_ids | Relates list of contacts to deal. They Should be sent in the request while creating and updating contacts. | List of contact id.ex: ["122", 145,201]. | Write access to relate contacts, while returning contact jsons respective to ids set | No | IDs of contacts. |
###Deal JSON Example
{
"id" : "822",
"name" : "Game development",
"description" : "Visual 3D based Online Game.",
"expected_value" : "50000",
"pipeline_id" : "43535822",
"milestone" : "progress",
"probability ": "70",
"close_date" : "1349980200",
"created_time" : "1356325843",
"entity_type" : "deal",
"Prefs": {
"id" : "984",
"template" : "blue",
"currency" : "USD",
"signature" : "- Powered by AgileCRM",
"task_reminder" : "true"
}
}##2.1 Listing deals ###dev/api/opportunity Method: GET
- Returns list of all "Deals" in the domain in JSON format, which are ordered by created time. Paging can be applied using the page_size and cursor query parameters. Count of the deals will be in the first deal and the cursor for the next page will be in the last deal of the list. If there is no cursor, it means that it is the end of the list.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/opportunity?page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept:application/json" -v -u {email}:{API Key}###Example response:
[
{
"id": 981,
"name": "premium subscriptions",
"contacts": [
{
"id": 2363,
"type": "PERSON",
"created_time": 1359033520,
"updated_time": 1359033533,
"star_value": 0,
"lead_score": 0,
"tags": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "John"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Olsen"
},
{
"type": "SYSTEM",
"name": "email",
"value": "john@example.com.com"
}
],
"domainUser": {
"id": 516,
"email": "test@example.com",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram"
}
}
],
"description": "Deal premium plan subscription",
"expected_value": 300,
"pipeline_id" : "43535822",
"milestone": "Open",
"probability": 46,
"close_date": 1371753000,
"created_time": 1360503631,
"entity_type": "deal",
"owner": {
"id": 516,
"email": "test@example.com",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "Test"
},
"prefs": {
"id": 984,
"pic": "",
"template": "blue",
"width": "",
"currency": "USD",
"signature": "- Powered by AgileCRM",
"task_reminder": true,
"currentDomainUserName": "?"
},
"pic": ""
},
{
"id": 981,
"name": "premium subscriptions",
"contacts": []
}
]###Other Response - Statuses:
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.2 Get deal by its id ###dev/api/opportunity/{id} Method: GET - Gets the deal with the given ID. ###Using curl :
curl https:{domain}.agilecrm.com/dev/api/opportunity/981 -H "Accept : application/json" -v -u {email}:{API Key}###Example Response :
{
"id": 981,
"name": "500 premium subscriptions",
"contacts": [
{
"id": 2363,
"type": "PERSON",
"created_time": 1359033520,
"updated_time": 1359033533,
"star_value": 0,
"lead_score": 0,
"tags": [
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "John"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Olsen"
},
{
"type": "SYSTEM",
"name": "email",
"value": "john@example.com"
},
],
"domainUser": {
"id": 516,
"email": "test@example.com",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1360503513,\"created_time\":1353507148}"
}
}
],
"description": "Deal premium plan subscription",
"expected_value": 300,
"pipeline_id" :"43535822",
"milestone": "Open",
"probability": 46,
"close_date": 1371753000,
"created_time": 1360503631,
"entity_type": "deal",
"owner": {
"id": 516,
"email": "test@example.com",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1360503513,\"created_time\":1353507148}"
},
"prefs": {
"id": 984,
"pic": "",
"template": "blue",
"width": "",
"currency": "USD",
"signature": "- Powered by AgileCRM",
"task_reminder": true,
"currentDomainUserName": "?"
},
"pic": ""
}###Other Response - Statuses:
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.3 Create Deal ###dev/api/opportunity Method: POST
- Accepts deal JSON as data in Post request to the url specified above, which creates new deal and returns the deal JSON with id field generated when new deal is created. If Post data includes valid deal id, respective deal is updated with the data sent in request. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in the wrong case, it will not be shown in the milestone view.)
###Using curl
curl https://{domain}.agilecrm.com/dev/api/opportunity -H "Content-Type: application/json" -d ‘{\"name\" : \"deal\", \"contact_ids\" : [\"2358\", \"2356\"] , \"owner_id\" : \"516\", \"pipeline_id\" :\"43535822\", \"milestone\" : \"milestone\"}’ 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST ###Response - Statuses:
- Status 200: Deal added successfully and it returns the newly created deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##2.4 Update Deal ###dev/api/opportunity Method: PUT
- Accepts Deal JSON. Id parameter of the deal should be specified. It indicates the deal to be updated with the new data sent. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in wrong case, it will not be shown in the milestone view.)
###Using curl
curl https://{domain}.agilecrm.com/dev/api/opportunity -H "Content-Type: application/json" -d "{\"name\" : \"deal\", \"contact_ids\" : [\"2358\",\"2356\"] , \"owner_id\" : \"516\", \"pipeline_id\" :\"43535822\", \"milestone\" : \"milestone\"}" -v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X PUT###Response - Statuses:
- Status 200: Deal updated successfully and it returns the updated deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##2.4 Create Deal to a contact using Email Id ###dev/api/opportunity/email/{email} Method: POST
- Accepts deal JSON as data in Post request to the url specified above, which creates new deal and returns the deal JSON with id field generated when new deal is created. If Post data includes valid deal id, respective deal is updated with the data sent in request. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in the wrong case, it will not be shown in the milestone view.)
###Using curl
curl https://{domain}.agilecrm.com/dev/api/opportunity/test@agilecrm.com -H "Content-Type: application/json" -d ‘{"name" : "deal", "owner_id" : "516", \"pipeline_id\" :\"43535822\", \"milestone\" : \"milestone\"}’ 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST Creates a deal for the contact with the given email address. If there is no contact, it will not create any deal.
###Response - Statuses:
- Status 200: Deal added successfully and it returns the new created deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##2.5 Delete Deal ###dev/api/opportunity/{id} Method: DELETE
- Deletes the deal based on the id specified in the url.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/opportunity/{id} -H "Content-Type: application/json" -v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X DELETE###Response - Statuses:
- Status 200: Deal deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.6 Bulk Delete ###dev/api/opportunity/bulk Method: POST
- Accepts list of deal ids in Post request and deletes all deals based on list of ids sent.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/opportunity/bulk -H "Content-Type: application/x-www-form-urlencoded" -d ‘{"ids" : ["123", "234", "235"]}’ -v -u {email}:{API Key} -X POST###Response - Statuses:
- Status 200: Deal deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.7 Get Deals from Default track grouped by milestones: ###dev/api/opportunity/byMilestone Method: GET
- Fetches list of deals from the default track grouped by milestones. Number of milestones depends upon the milestones added by user to default track.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/opportunity/byMilestone -H "Accept : application/json" -v -u {email} : {API Key}###Example Response :
{
"Lost": [
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Open: [
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Won: [
{
"cursor": "",
"count": "",
"id": 5123586478047232,
"name": " deal test",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/21/2014"
}
],
"description": "",
"expected_value": 1.0E10,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 10,
"close_date": 1405036800,
"owner_id": "",
"created_time": 1405575543,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Stage1: [
{
"cursor": "",
"count": "",
"id": 5193799529660416,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2.0E11,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 98,
"close_date": 0,
"owner_id": "",
"created_time": 1402580362,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
]
}In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
###Response - Statuses:
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.8 Get Deals for a particular Track (grouped by Milestone). ###dev/api/opportunity/byPipeline/based Method: GET
- Fetches list of deals from the particular track grouped by milestones. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter. If 0 is sent as the parameter, it will give the list of deals from the default track.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/opportunity/byPipeline/based?pipeline_id=4756437 -H "Accept : application/json" -v -u {email} : {API Key}###Example Response :
{
"Lost": [
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Open: [
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
]
}In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
###Response - Statuses:
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.9 Get Deals from particular track: ###dev/api/opportunity/based Method: GET
-
Fetches list of deals from the particular track. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter.
- If 0 is sent as the parameter, it will give the list of deals from the default track.
- If 1 is sent as the parameter, it will give the list of all deals from all tracks.
Paging can be applied using the page_size and cursor query parameters. Count of the deal will be in the first deal and Cursor for the next page will be in the last deal of the list. If there is no cursor, it means that it is the end of list.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/opportunity/based?pipeline_id=4756437&page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept : application/json" -v -u {email} : {API Key}###Example Response :
[
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
},
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
] In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
###Response - Statuses:
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.10 Get Deals Related To Specific Contact ###dev/api/contacts/{id}/deals Method: GET
- Fetches list of deals related to specified contact using the contact id.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/deals -H "Accept : application/json" -v -u {email} : {API Key}###Example Response :
[
{
"id" : 822,
"name" : "Game Development",
"created_time" : 1356325843,
"contacts" : [
{
id : "445",
created_time : 1356315843
…
}
...
]
…
},
{
"id" : 850,
"name" : "Product Design",
"created_time" : "1357794282",
…
},
...
]###Response - Statuses:
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
##2.11 Get Deals of Current user (my deals) ###dev/api/opportunity/my/deals Method: GET
- Fetches list of deals of the current user
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/opportunity/my/deals -H "Accept : application/json" -v -u {email} : {API Key}###Example Response :
[
{
"id" : 822,
"name" : "Game Development",
"created_time" : 1356325843,
"contacts" : [
{
id : "445",
created_time : 1356315843
…
}
...
]
...
},
{
"id" : 850,
"name" : "Product Design",
"created_time" : "1357794282",
…
},
...
]###Response - Statuses:
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Notes API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when note is created | Long | no | no | N/A |
| created_time | Creation time of note | Long | yes | no | epoch time |
| subject | Subject of the note | String | no | yes | N/A |
| description | Description of note | String | no | yes | N/A |
| contact_json | list of contact ids | String array | no | no | N/A |
##3.1 Create a note and relate that to contacts : ###/dev/api/notes Method: POST
- Creates a note and relates it to contacts, which are sent in the note JSON contact field.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/notes/ -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"subject" : " Note subject" , "description" : "Note description", "contact_ids" : ["721001", "722001"] }’ -v -u {email} : {APi Key} -X POST###Example response :
{
"id" : 80001
"created_time" : 1360561958,
"subject" : "Note subject",
"description" : "Note description",
"contacts" : ["721002"],
"entity_type" : "note"
}###Response - Statuses:
- Status 200: Note added successfully and it returns the newly created note as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##3.2 Add Note to a Contact using Email-ID: ###dev/api/contacts/email/note/add Method: POST
- Adds a note to the contact with given Email-ID. Email address and the note object should be sent as url-encoded form parameters to the above given URL.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/email/note/add -H "Accept: application/xml"
-H "Content-Type :application/x-www-form-urlencoded"
-d ‘email=notifications@basecamp.com¬e={"subject":"test","description":"testing description"}’ -v -u {email}:{apikey} -X POST###Response:
- Status 204: Note added successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
##3.3 Gets notes related to specific contact : ###/dev/api/contacts/{contact_id}/notes Method: GET
- Returns list of note JSONs related to the contact.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/contacts/710002/notes -H "Accept : application/json" -v -u {email} : {API Key}###Example response :
[
{
"id" : 79001,
"created_time" : 1360561958,
"subject" : "Note subject1",
"description" : "Note description1",
"contacts" : ["721002"],
"entity_type" : "note"
},
{
"id" : 80001
"created_time" : 1360561722,
"subject" : "Note subject2",
"description" : "Note description2",
"contacts" : ["721002"],
"entity_type" : "note"
}
]##3.4 Delete a specific note from specific contact : ###/dev/api/contacts/{contact_id}/notes/{note_id} Method: DELETE - Deletes the note of the specific contact. (It will remove the relationship between the note and the contact.)
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/notes/{note_id} -H "Accept : application/json" -v -u {email} : {API Key} -X DELETE###Response:
- Status 204: Note removed successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
- Tasks API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when task is created | Long | no | no | N/A |
| type | Determines the type to which the task belongs. The type should be in the given list. It is case sensitive. It should only be specified as mentioned here - | String | no | yes | CALL, EMAIL, FOLLOW_UP, MEETING, MILESTONE, SEND, TWEET, OTHER. |
| priority_type | Determines the priority of the task. It is case sensitive. It should only be specified as mentioned here. | String | no | yes | There are 3 kinds of priorities - HIGH, NORMAL, LOW. |
| due | Due date of the task. It should be specified as Epoch Time. | Long | no | yes | Epoch time |
| created_time | Creation time of task | Long | yes | no | Epoch time |
| is_complete | Determines whether the task is completed or not. If completed, then true. Else, false. | Boolean | no | no | true/false |
| contacts | List of contacts related to the task. While saving, the contact ids have to be given as a string array to relate them to the task. | String array | no | no | ID’s of the contacts. |
| subject | Subject of the task. | String | no | yes | N/A |
| entity_type | It is a read only variable. Its value is ‘task’ always. | String | yes | no | task |
| notes | It is the list of notes related to this task. While adding or editing a task, the list of note id’s has to be sent as a string array in order to save them. | String array | no | no | N/A |
| progress | It is used to determine the progress of the task. (0-100%) | Int | no | no | 0 to 100 |
| status | Determines the status of the task. | String | no | no | YET_TO_START, IN_PROGRESS, COMPLETED. These are case sensitive. |
| taskOwner | It has the information about the owner of the task. | JSON object | yes | no | N/A |
| owner_id | lId of the user who is the owner of the task. Send this field in the task object while adding or updating the task in order to assign the task to the owner. | Long | no | no | Id of the user(Owner) |
##4.1 Get the list of pending tasks: ###dev/api/tasks Method: GET
- Retrieves all the pending tasks of all the users. It will return a list of tasks as a JSON Array.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
...
}
]##4.2 Get all tasks: ###dev/api/tasks/all Method: GET
- Get all the tasks of all the users. It will get both the pending and the completed tasks of all the users.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/all -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": true,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
...
}
]##4.3 Get the list of pending tasks depending on the number of pending days: ###dev/api/tasks/pending/{num-days} Method: GET
- Retrieve the pending tasks of all the users which are ‘num-days’ days away from the due date. It will return the list of tasks as a JSON Array.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/pending/3 -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
...
}
]##4.4 Get the list of tasks of current user: ###dev/api/tasks/my/tasks Method: GET
- Retrieves all the tasks of the current user. It will return the list of tasks as a JSON Array.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/my/tasks -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
...
}
]##4.5 Get the list of tasks based on given filters: ###dev/api/tasks/based Method: GET
- Retrives the list of tasks based on the given filters. The filters available are ‘type’, ‘owner’, ’pending’, ‘start_time’, ‘end_time’ and ‘page_size’. These should be sent as a query parameters in the URL. Filters 'start_time' and 'end_time' are the epoch time and these will filter by the due date of the task.
Paging can be applied using the page_size and cursor query parameters. Count of the tasks will be in the first task and Cursor for the next page will be in the last task of the list. If there is no cursor, it means that it is the end of list.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/based?pending=true&type=EMAIL&page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
...
}
]##4.6 Get the task based on ID: ###dev/api/tasks/{id} Method: GET
- Gets the task of the contact with the given ID.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key}###Response:
- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.) ###Example response:
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
}##4.7 Create a task: ###dev/api/tasks Method: POST
- Creates a new task.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/tasks -H "Content-Type: application/json" -d ‘{"subject" : "test", "contacts" : ["5704147139559424"] , "owner_id" : "5345980119515136", \"type\" : \"EMAIL\", \"priority_type\" : \"HIGH\", \"due\" : 11545245654}’ 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST ###Response:
- Status 200: Task added successfully and it returns the newly created task as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
###Example response:
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": 11545245654,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "test",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
}##4.8 Create a task based on Contact email: ###dev/api/tasks/email/{email} Method: POST
- Creates a new task and relates it to the contact having the email.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/tasks/email/test@agilecrm.com -H "Content-Type: application/json" -d ‘{"subject" : "test", "owner_id" : "5345980119515136", \"type\" : \"EMAIL\", \"priority_type\" : \"HIGH\", \"due\" : 11545245654}’ 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X POST ###Response:
- Status 200: Task added successfully and it returns the newly created task as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
###Example response:
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": 11545245654,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "test",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
}##4.9 Update a task: ###dev/api/tasks Method: PUT
- Updates a task. The ID of the task has to be specified.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/tasks -H "Content-Type: application/json" -d ‘{"id" : 5149503652888576", "subject" : "test", "contacts" : ["5704147139559424"] , "owner_id" : "5345980119515136", \"type\" : \"EMAIL\", \"priority_type\" : \"HIGH\", \"due\" : 11545245654}’ 000-v -u test@example.com:4uet78u6atfn38m9dounnq9g4u -X PUT ###Response:
- Status 200: Task updated successfully and it returns the newly updated task as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
###Example response:
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": 11545245654,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "test",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "prabath.kolipaka@gmail.com",
"is_admin": true,
...
}##4.10 Delete a task based on ID: ###dev/api/tasks/{id} Method: DELETE
- Deletes the task having the given ID.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/tasks/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE###Response:
- Status 204: Task deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Events API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted Values |
|---|---|---|---|---|---|
| id | Unique id generated when event is created | Long | no | no | |
| created_time | Creation time of Event | Long | yes | no | Epoch time |
| allDay | Determines whether the event lasts for the whole day or not. | Boolean | no | no | true / false |
| contacts | List of contacts related to the event. While saving, the contact ids have to be given as a string array to relate them to the event. | String array | no | no | ID’s of the contacts |
| title | Title of the event | String | no | yes | N/A |
| color | Color states the priority of the event. | The colors are case sensitive. All of them should be specified in the same case. | String | no | no |
| start | Start time of Event in epoch time format. | Long | no | yes | epoch time |
| end | End time of Event in epoch time format. | Long | no | yes | epoch time |
| is_event_starred | It determines whether the particular event is starred or not. | Boolean | no | no | true / false |
##5.1 Get List of Events: ###dev/api/events Method: GET
- Fetches the list of events happened in particular time. The start time and end time have to be sent in epoch format as query parameters.
###Using curl curl https:{domain}.agilecrm.com/dev/api/events?start=1409423400&end=1413052200 -H "Accept:application/json" -v -u {email}:{API Key}
###Response:
- Status 200: Gets the list of events.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
###Example Response:
[
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
"star_value": 0,
"lead_score": 0,
"tags": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Basecamp (2Desk)"
},
...
],
...
}
]
},
{
"id": 5740240702537728,
"start": 1409769000,
"end": 1409855340,
"is_event_starred": false,
"allDay": false,
"title": "tlest",
"color": "green",
"created_time": 1410421808,
"contacts": [
{
"id": 5727217287954432,
"type": "PERSON",
"star_value": 0,
"lead_score": 1,
"tags": [
" mobile",
"test"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "test first"
}
...
],
...
}
]
}
]##5.2 Get Events related to Contact: ###dev/api/contacts/{contact_id}/events/sort Method: GET
- Retrieves the events related to contact sorted by date.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/events/sort -H "Accept: application/xml" -v -u {email}:{apikey}###Response:
- Status 200: Returns the events list related to the contact.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
###Example Response:
[
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
…...
}
]
}
]##5.3 Create Event: ###dev/api/events Method: POST
- Creates an event.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/events -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"title" : "Today Test event" , "allDay" : true, "color" : "red" , "start":1409682600,"end":1409768100, "contact_ids" : ["721001", "722001"] }’ -v -u {email} : {APi Key} -X POST###Example response :
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 721001,
"type": "PERSON",
...
}
]
}###Response - Statuses:
- Status 200: Event added successfully and it returns the newly created event as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##5.4 Update Event: ###dev/api/events Method: PUT
- Updates an event. To update the event, the event id has to be provided in the request object. Otherwise, it will be considered as a new event.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/events -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"id": 5758048710688768, "title" : "Today Test event" , "allDay" : true, "color" : "red" , "start":1409682600,"end":1409768100, "contact_ids" : ["721001", "722001"] }’ -v -u {email} : {APi Key} -X PUT###Example response :
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 721001,
"type": "PERSON",
...
}
]
}###Response - Statuses:
- Status 200: Event updated successfully and it returns the updated event as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##5.5 Delete an Event: ###dev/api/events/{id} Method: DELETE
- Deletes the event with the particular id. The id passed in the url will be used to identify the event.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/events/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE###Response:
- Status 204: Event deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Track / Milestones API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when Track is created | Long | no | no | N/A |
| name | Name of the track | String | no | yes | N/A |
| milestones | Comma separated strings. Each string is a milestone and these are case sensitive. All of them should be specified in the same case. The first letter of the track needs to be specified in upper case. | String | no | yes | N/A |
##6.1 Get all the Tracks: ###dev/api/milestone/pipelines Method: GET
- Gets all the tracks. Each track will be having a set of milestones.
###Using curl
curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Accept: application/xml" -v -u {email}:{apikey}###Response:
- Status 200: Returns the events list related to the contact.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
###Example Response:
[
{
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}
]##6.2 Create a Track: ###dev/api/milestone/pipelines Method: POST
- Creates a track. Name should not be "Default". Milestone fields should be a single string - a group of multiple strings separated by comma. First letter of all the milestones should be in uppercase.
###Using curl : ```sh` curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"name" : "Test" , "milestone" : "Open,New,Prospect,Proposal,Won,Lost" }’ -v -u {email} : {APi Key} -X POST
###Example Response:
```javascript
{
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}
###Response - Statuses:
- Status 200: Track created successfully and it returns the newly created track as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##6.3 Update a Track: ###dev/api/milestone/pipelines Method: PUT
- Updates a track. Name should not be "Default". Milestone fields should be a single string - group of multiple strings separated by comma. First letter all the milestones should be in uppercase. The Id of the track needs to be specified in the request json to update the track. Otherwise, it will be considered as a new track.
###Using curl :
curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"id": 5146448186310656,
"name" : "Test" , "milestone" : "Open,New,Prospect,Proposal,Won,Lost" }’ -v -u {email} : {APi Key} -X PUT###Example Response:
{
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}###Response - Statuses:
- Status 200: Track updated successfully and it returns the updated track as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
##6.4 Delete a Track: ###dev/api/milestone/pipelines/{id} Method: DELETE
- Deletes the track with the particular id. The id passed in the url will be used to identify the track.
###Using curl
curl https:{domain}.agilecrm.com/dev/api/milestone/pipelines/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE###Response:
- Status 204: Track deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)