Read records

Use this REST endpoint to get a list of entity records using the entity name within the request path. Use the HTTP GET method to call this resource.

The result will include all entity fields in the response and cannot load field values from referenced related entities via Lookup or Master/Detail relationships if no specific field list is identified.

curl GET 'https://{domain}/api/3.0/entity/{entity_name}'
  -H 'Content-Type: application/json'
  -H 'Accept: application/json'
  -H 'Authorization: Bearer {access_token}'

Request

entity_name string Required

The API name of the entity from which to retrieve the record. Ensure this value is a valid entity API Name.

Request Query String

fields string Optional

A comma-separated list of fields to load. This list of fields should be URL encoded.

sortstring Optional

The field name by which the result-set should be sorted; by default, the result-set is sorted by the "Id" field.

order string Optional

Specifies the ascending or descending order of the records.

limit number Optional

The number of records to read from the database entity; if it is not specified, 1,000 records will be retrieved by default.

offset number Optional

The number of records to skip in the result set is used mainly for pagination. Combine this with the "sort" option for the best results.

Example

curl 
 -X GET 'https://{domain}/api/3.0/entity/contact?limit=5&fields=Id,Name,Account.Name'
 -H 'Content-Type: application/json'
 -H 'Accept: application/json'
 -H 'Authorization: Bearer {access_token}'

Successful Response

HTTP 200 OK

{
    "Records": [
        {
            "Id": "00700000000001C0000",
            "Name": "David Smith",
            "Account": {
                "Name": "Stäcker Motion Inc."
            }
        },
        {
            "Id": "00700000000001D0000",
            "Name": "Jeni Sooma",
            "Account": {
                "Name": "Stäcker Motion Inc."
            }
        },
        {
            "Id": "00700000000001E0000",
            "Name": "Mat Wolfe",
            "Account": {
                "Name": "Stäcker Motion Inc."
            }
        },
        {
            "Id": "00700000000001F0000",
            "Name": "John Brown",
            "Account": {
                "Name": "Falcon Machine Co."
            }
        },
        {
            "Id": "00700000000001K0000",
            "Name": "Debra Malcolm",
            "Account": {
                "Name": "Falcon Machine Co."
            }
        }
    ],
    "Count": 23588
}

Failed Response

HTTP 400 Bad Request

{
    "message": "Field Name2 does not exist in Contact Entity.",
    "success": false
}