Retrieve
Estimated reading: 1 minute
HTTP Method: GET
Base Syntax:
http://deepserhost/api/rest/[entity]/[id]
Example Syntax:
http://deepserhost/api/rest/company/4
Description: retrieves the entity data, given an entity ID.
Example Result:
http://deepserhost/api/rest/company/4
{
"entity_id": "4",
"parent_id": "1",
"sort_order": null,
"name": "ACME UK",
"description": "ACME UK",
"phone": "08567565",
"fax": "8587575",
"address": "Carnaigehall Street",
"city": "London",
"state": "London",
"country": "UK",
"zip_code": "10000",
"notes": null,
"logo": "company/image/a/c/acme_uk.png",
"primary_contact": "4\\nobel",
"mailbox_id": "0",
"status": "1",
"formtemplate_id": "56",
"updated_at": "2018-08-01 15:04:59",
"created_at": "2018-07-12 08:39:16",
}
Note that every custom field created in Deepser is retrieved by the API. Custom fields have the prefix cust_ before their name.
So, for example, if a user creates a field named website, the REST API will return a JSON property called cust_website.