Look up a Tulip Table
- 01 Oct 2024
- 2 Minutes to read
- Contributors
- Print
Look up 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}
Gets details about a Tulip Table's metadata and schema.
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
Responses
200
The Tulip Table was retrieved successfully.
object
Example{ "id": "gthSX9t3tY2cJfBWe", "label": "Bike", "description": "A Bicycle", "createdAt": "2019-01-15T05:30:01Z", "createdBy": "N24uug8iXSTWR39rB", "updatedAt": "2019-01-15T05:31:20Z", "updatedBy": "N24uug8iXSTWR39rB", "columns": [ { "name": "id", "label": "ID", "description": "", "dataType": { "type": "string" }, "hidden": false, "unique": true }, { "name": "ahvbb_model_number", "label": "Model Number", "description": "", "dataType": { "type": "string" }, "hidden": false, "unique": false }, { "name": "auznd_color", "label": "Color", "description": "", "dataType": { "type": "string" }, "hidden": false, "unique": false }, { "name": "irrip_completed", "label": "Completed", "description": "", "dataType": { "type": "boolean" }, "hidden": false, "unique": false }, { "name": "umiyk_durability_test_duration", "label": "Durability Test Duration", "description": "", "dataType": { "type": "interval" }, "hidden": false, "unique": false } ] }
id
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
createdAt
string (date-time)
createdBy
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
updatedAt
string (date-time)
updatedBy
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
deletedAt
string (date-time)
deletedBy
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
label
string
The display label for this Table.
description
string
A long-form description for this Table.
columns
Array of object (TulipTableColumn)
object
Example{ "name": "ahvbb_model_number", "label": "Model Number", "description": "", "dataType": { "type": "string" }, "hidden": false, "unique": false }
name
string
The internal id of this column.
Pattern^[a-zA-Z][a-zA-Z0-9_]*$
label
string
The display label for this column.
description
string
A long-form description for this column.
dataType
object (TypedObjectType)
The type of a value in Tulip.
type
string
Valid values[ "boolean", "string", "float", "integer", "interval", "timestamp", "imageUrl", "user", "color" ]
ExampleimageUrl
hidden
boolean
Whether this column is hidden from the UI or not.
unique
boolean
Whether values in this column are required to be unique or not.
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" ]
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?
