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.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
target_name
The name of the table to read from.
target_type
The type of target. Either ‘table’ or ‘core-table’.
filters
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' returns exactly one record and throws an error if more than one matching record exists, 'multiple' returns all matches.
Response
OK
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error