Configure Typed Read API Parameters

Control Typed Read API results by retrieving one instance by ID, choosing returned fields, and paginating with limit and startAfter.

1 min read

After you have learnt how to Get Started with the Typed Read API

In your Read API documentation:

  1. Click on Authorize
  1. Paste the API token you have copied to your clipboard
  1. Click on Authorize
  1. Close your available authorizations window
  1. Go to your concept API
ParameterWhat it does
concept API idIndicate what name of single id field you want to display example: https://<your-instance>.yooi.io/api/store/type/business-domain/id/{id}
queriesOn your queries box, include the comma-separated values of the fields' API aliases to show in the response. If omitted, all fields will show in the response.
limitOn your limit space, include the field that will define how many elements you want to show in the response. (This is a number field)
startAfterOn your startAfter, include the field that will define the last field you need to have to get the next batch of responses.

Read more

Related articles

Was this page helpful?