Skip to main content

Retrieve a Resource

The Retrieve method fetches a single entity from Deepser by its ID using an HTTP GET request. The response returns a JSON object containing all fields of the requested entity, including any custom fields.

Syntax​

HTTP Method: GET

URL:

http://deepserhost/api/rest/[entity]/[id]

Example​

The following request retrieves the company with ID 4:

URL:

http://deepserhost/api/rest/company/4

Response:


					{
    "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

Every custom field created in Deepser is also returned by the API. Custom fields have the prefix cust_ before their name. For example, if you create a field named website, the REST API returns a JSON property called cust_website.