Tools

Read

Read records from a table.

Returns records from the specified table matching the given filters. Use 'single' mode to retrieve exactly one record, or 'multiple' mode to retrieve all matching records.

Requires an API key with the read scope.

post/api/v1/tools/read

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/tools/read
  • Auth: HTTP bearer

Request body

target_namestring required

The name of the table to read from.

target_type'table' | 'core-table' required

The type of target. Either 'table' or 'core-table'.

filtersobject

Key-value filters to apply to the query. Omit to match all records. A key may follow a foreign key onto another readable table, as in instrument_type__name; tables the read tool does not return are not traversable.

mode'single' | 'multiple'

'single' returns exactly one record and throws an error if more than one matching record exists, 'multiple' returns all matches.

Response

OK

object[] required

Changes

No recorded changes to this operation across all 1 revision of this API.