Skip to main content

List extra suboption metafields

API operation: Open the endpoint in Scalar

Use GET /business/{business_id}/extras/{extra_id}/options/{option_id}/suboptions/{suboption_id}/metafields to list metadata attached to one extra suboption. The current public operation is ExtraOptionSuboptionMetafield.findAll.

The endpoint returns metafields for the ExtraOptionSuboption model, identified by the route's suboption_id.

Authentication is required. This list supports field selection, sorting, filtering, and pagination.

See create an extra suboption metafield or the extra option suboption model for related context.

OpenAPI reference​

Operation: GET /business/{business_id}/extras/{extra_id}/options/{option_id}/suboptions/{suboption_id}/metafields

Path parameters

NameTypeRequiredDescription
business_idintegerYes—
extra_idintegerYes—
option_idintegerYes—
suboption_idintegerYes—

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBystringNoField to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
wherestringNoJSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
pageintegerNoPage number, starting at 1. Applies only to lists that return a pagination block.
page_sizeintegerNoNumber of items per page.

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference