List records of a Tulip Table
- 17 Jan 2024
- 3 Minutes to read
- Contributors
- Print
List records of a Tulip Table
- Updated on 17 Jan 2024
- 3 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/tables/{tableId}/records
Lists the records in a Tulip Table, optionally filtered by the query parameters.
Requires the tables:read API key scope.
Security
Http
Type basic
A Tulip API key is required to use the Tulip API. API key authentication uses HTTP Basic Authentication as defined by [RFC 7617](https://tools.ietf.org/html/rfc7617). HTTP Basic Authentication uses a generic username/password scheme to authenticate. For Tulip API requests, the password should be the API key's associated secret. The username should have the format `{type}.{version}_{id}`, where `{type}` is the API key type, `{version}` is the type's version number, and `{id}` is the id of the key. Tulip API keys currently are one of two types: * `apikey.2` - user API keys provisioned by creating a Tulip API Bot. The key id is the bot id. * `onetime.1` - temporary API keys provisioned using the `/auth/temporary` endpoint or using the [One-Time API Key page](https://templates.tulip.co/apiKey). These keys are only valid for 30 seconds after provisioning. Once you have determined the username and password you need to use, the `Authorization` header should be set to the value `Basic {credentials}`, where `{credentials}` is the base64-encoded value of the string `{username}:{password}`. See [RFC 7617](https://tools.ietf.org/html/rfc7617) for more details of this encoding.
Path parameters
tableId
stringRequired
The id of a Tulip Table.
Pattern^[a-zA-Z0-9]+$
Query parameters
limit
integer
A limit for how many records should be returned in the response. At most this many records will be returned. To determine if there are more records beyond those included in the response, use the includeTotalCount query parameter. Defaults to 10 records and cannot be more than 100 records.
Maximum100
Minimum1
Default"10"
offset
integer
The index of the record to start at. The exact order of returned records depends on the sortBy and sortDir parameters. This parameter is usually used for pagination.
Minimum0
Default"0"
includeTotalCount
boolean
If this flag is set, the total number of records in the Table which match the filters is returned in the X-Total-Count header in the response. Determining this count requires an extra (potentially expensive) database query, so clients should omit this flag if the total count is not needed.
Default"False"
filters
array of object
An optional array of filter expressions to filter the Table records by. Each filter is an object specifying the field (name of a table column), functionType (comparison function), and arg (the value to compare to).
The field may be the name of a table column (including id) or one of these special values:
_createdAt_updatedAt
The valid function types are:
equalnotEqualblanknotBlankgreaterThanOrEquallessThanOrEqualgreaterThanlessThancontainsnotContainsstartsWithnotStartsWithendsWithnotEndsWithisIn
The function argument is not required for blank and notBlank.
filterAggregator
string
How the filters in the filter parameter are combined. all means that every filter must match a record in order for the record to be included. any means at least one filter must match a record in order for the record to be included.
Valid values[ "all", "any" ]
Default"all"
sortOptions
array of object
Sort records to determine which are used in the aggregation. Sort priority is determined by the order or options, i.e. sort by the first option, them by the second, etc. If ommitted, there is no guarantee as to which records are selected. A sortBy value that is not one of the table's field will generate a 422 error. Options for sortDir are "asc" and "desc".
Example: [{"sortBy": "superAwesomeField", "sortDir": "asc"}, {"sortBy": "lessAwesomeField", "sortDir": "desc"}]
Responses
200
The list of Tulip Table records was retrieved successfully.
Headers
X-Total-Count
integer
The total number of records in the Table which match the filters. Only returned if the `includeTotalCount` query parameter is set.
Array of object
object
A single record stored in a Tulip Table. The record object will include the names and values of all columns of the Table that are not hidden, in addition to the record's sequence number, created timestamp, and last updated timestamp.
_sequenceNumber
integer
A monotonically increasing unique identifier for this record.
_createdAt
string (date-time)
_updatedAt
string (date-time)
400
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
401
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "AuthenticationRequired" ]
403
The provided authentication info was rejected. The response will provide additional details.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "AuthenticationFailed" ]
404
The requested database entry was not found.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "NoSuchDatabaseEntry" ]
422
The request was syntactically sound, but could not be processed due to a logical problem.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
errorCode
Valid values[ "UnprocessableEntity" ]
500
The server encountered an unexpected error.
object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
Was this article helpful?
