Partial Data

Overview

The show query parameter allows clients to specify which fields should be included in the API response for a given resource. By using this parameter, you can customize the response to include only the fields you need, improving efficiency and reducing payload size.

Usage

Selecting Single Fields

To include a specific field in the response, provide the field name as the value of the show query parameter. For example:

GET /api/resource?show=name

Response:

{
  "id": 1,
  "name": "Example Name"
}

Selecting Multiple Fields

To include multiple fields, you can:

Use a comma-separated list:

GET /api/resource?show=name,description

Response:

{
  "id": 1,
  "name": "Example Name",
  "description": "This is an example description."
}

Use an array-style query:

GET /api/resource?show[]=name&show[]=description

Response:

{
  "id": 1,
  "name": "Example Name",
  "description": "This is an example description."
}

To include fields from related resources, use dot notation to specify nested fields. This will automatically eager-load the related resources. For example:

GET /api/resource?show=name,company.name

Response:

{
  "id": 1,
  "name": "Example Name",
  "company_id": 2,
  "company": {
    "id": 2,
    "name": "Example Company"
  }
}

Behavior Notes

The id field of the resource is always included in the response, even if it is not explicitly specified in the show parameter.

Related resources are automatically eager-loaded when their fields are specified using dot notation, ensuring efficient database queries.

Should not be used in conjuction with Eager Loading (with)

Overview#

Usage#

Selecting Single Fields#

Selecting Multiple Fields#

Including Fields from Related Resources#

Behavior Notes#

Overview

Usage

Selecting Single Fields

Selecting Multiple Fields

Including Fields from Related Resources

Behavior Notes