Read

View as Markdown
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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
target_namestringRequired
The name of the table to read from.
target_typeenumRequired

The type of target. Either ‘table’ or ‘core-table’.

filtersmap from strings to anyOptional

Key-value filters to apply to the query. Omit to match all records.

modeenumOptionalDefaults to single
'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