Read a record related data

Use this REST endpoint to retrieve records related to a parent 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}/{navigation_property}'
  -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.

navigation_property string Required

The related-field name that provides access to child records (Child Relationship Name), you can see the options within IDE entity browser (Child Relationships folder).

Child Relationships shown in IDE

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 GET 'https://{domain}/api/3.0/entity/account/00200009034X1/contacts?limit=5'
  -H 'Content-Type: application/json'
  -H 'Accept: application/json'
  -H 'Authorization: Bearer {access_token}'

Successful Response

HTTP 200 OK

[
    {
        "AccountId": "0060000000000600000",
        "Birthdate": null,
        "CreatedById": "7NT0000000000000000",
        "CreatedOn": "2022-09-09T18:43:00.317",
        "Email": "frank.d@company.com",
        "Fax": null,
        "Firstname": "Frank",
        "Id": "00700000000004Y0000",
        "Lastname": "Dorfa",
        "ModifiedById": "7NT0000000000000000",
        "ModifiedOn": "2022-09-09T18:43:25.383",
        "Name": "Frank Dorfa",
        "OwnerId": "7NT0000000000000000",
        "Phone": null,
        "RecordTypeId": "7OR00000000001L0000",
        "Title": "Field Manager"
    }
]

Failed Response

HTTP 404 Not Found

{
    "message": "Invalid navigation field 'invoices'.",
    "success": false
}

Table of Contents