Get a custom tab
Retrieve a specific custom tab by ID.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Custom tab ID.
Match
^[a-zA-Z0-9-]+$Length
1 <= length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.orbiqhq.com/api/v1/custom-tabs/tab-123"{
"success": true,
"data": {
"customTab": {
"id": "tab-123",
"slug": "vendor-assurance",
"title": "Vendor Assurance",
"order": 1,
"enabled": true,
"access_level": "public",
"content": {
"layers": [
{
"id": "section-1",
"type": "tc-section",
"props": {
"width": "contained",
"padding": "md",
"background": "none"
},
"children": [
{
"id": "markdown-1",
"type": "tc-markdown",
"props": {
"content": "## Overview"
}
}
]
}
],
"variables": []
},
"content_schema_version": "1.0",
"date_created": "2024-05-12T10:11:12Z",
"date_updated": "2024-05-12T10:11:12Z",
"translations": [
{
"id": "tr-1",
"languages_code": "en-US",
"title": "Vendor Assurance"
}
]
},
"resources": {
"documents": [
{
"id": "doc-1",
"title": "SOC 2 Report",
"subtitle": "Compliance"
}
],
"certifications": [
{
"id": "cert-1",
"title": "ISO 27001",
"subtitle": "public"
}
],
"knowledgeBase": [
{
"id": "kb-1",
"title": "How do you handle encryption?",
"subtitle": "public"
}
],
"subprocessors": [
{
"id": "sub-1",
"title": "Cloud Hosting",
"subtitle": "US"
}
]
}
}
}{
"code": "invalid_id",
"message": "The custom tab id format is invalid.",
"details": "Use a valid tab id from the Custom Tabs list."
}{
"code": "unauthorized",
"message": "Authentication required.",
"details": "Include a valid Authorization header."
}{
"code": "forbidden",
"message": "You do not have access to this custom tab.",
"details": "Ensure your role grants custom tab access."
}{
"code": "not_found",
"message": "Custom tab not found.",
"details": "Confirm the tab id in the admin center."
}{
"code": "internal_error",
"message": "Unexpected server error.",
"details": "Try again or contact support."
}How is this guide?