Read a record
Use this REST endpoint to retrieve a single record by its unique record ID. The response will include all entity fields. Note that if no specific field list is provided, field values from referenced related entities (via Lookup or Master/Detail relationships) will not be loaded.
curl GET 'https://{domain}/api/3.0/entity/{entity_name}/{record_id}'
-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.
record_id string Required
The unique ID of the record to be retrieved.
Request Query String
fields string Optional
A comma-separated list of fields to load. This list of fields should be URL encoded.
Example
curl
GET 'https://{domain}/api/3.0/entity/account/00200009034X1?fields=Id,Name,CreatedBy.Name'
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Bearer {access_token}'
Successful Response
HTTP 200 OK
{
"Id": "00200009034X1",
"Name": "Gain Tetra Inc.",
"CreatedBy":
{
"Name": "David Smith"
}
}
Failed Response
HTTP 404 Not Found
{
"message": "Record not found or unauthorized access",
"success": false
}
What Is Next?