Look up a record of a Tulip Table
- 01 Oct 2024
- 2 Minutes to read
- Contributors
- Print
Look up a record of a Tulip Table
- Updated on 01 Oct 2024
- 2 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/tables/{tableId}/records/{recordId}
Looks up a Tulip Table record by id.
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. 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 Token. The key id is the token id.onetime.1- temporary API keys provisioned using the/auth/temporaryendpoint or using the One-Time API Key page. 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 for more details of this encoding.
Path parameters
tableId
stringRequired
The id of a Tulip Table.
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
recordId
stringRequired
The id of a Tulip Table record.
Pattern^[\S]+( +[\S]+)*$
Examplea record id
Query parameters
fields
array of string
Specifiying fields allows to reduce the amount of data returned in the result to just the data for each of the fields specified. If ommitted, all fields for a given record will be returned. A field value that is not one of the table's fields will generate a 422 error.
Example: ["ipwkk_weight", "cyveu_completed", "id", "_updatedAt", "bDabBK8jmxZqWY8iT_link_left_column"]
field
array of string
A list of fields of the record that should be fetched. If an empty list is given, or if the query parameter is left out, all fields will be returned. If specified along with the fields query parameter, a 422 error will be returned. This parameter is deprecated and will be removed in a future version - please use the fields query parameter instead.
Responses
200
The Tulip Table record was retrieved successfully.
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.
Example{ "_sequenceNumber": 15, "_createdAt": "2019-02-08T20:16:31Z", "_updatedAt": "2019-02-08T20:16:31Z", "id": "bike-a", "ahvbb_model_number": "AAA", "auznd_color": "blue", "irrip_completed": true, "umiyk_durability_test_duration": 123000 }
_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 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
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?
