API Endpoint: Get All Category Items

The Get All Category Items endpoint retrieves the list of items organized within the given category.

URL:

https://app.tettra.com/api/teams/{team_id}/categories/{category_id}

HTTP Method: GET

Parameters:

team_id (path): Team ID
category_id (path): The Category ID of the category
api_key (body): Your API Key

Request Example:

curl -X GET "https://app.tettra.com/api/teams/1/categories/12345" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "api_key": "YOUR_API_KEY"
    }'

Response (200):

{
    "success": true,
    "categoryItems": [
        {
            "id": 123456,
            "created_at": "2018-04-12 18:37:30",
            "updated_at": "2024-05-31 15:48:34",
            "title": "Templates Directory",
            "category_id": 12345,
            "is_dashboard_pinned": null,
            "dashboard_pin_id": null,
            "bookmark_id": null,
            "item_rank": null,
            "rank_id": null,
            "type": "Subcategory",
            "user_id": "0",
            "slug": "none",
            "can_update": 1,
            "icon": "/img/category-icons/folder.svg",
            "color": "ffd33b",
            "is_pinned": 0,
            "verification_schedule_id": null,
            "resource_type": null,
            "is_answered": null
        },
        {
            "id": 1234567,
            "created_at": "2024-04-19 19:39:37",
            "updated_at": "2024-05-06 15:43:30",
            "title": "Customer Service Terms Glossary",
            "category_id": 12345,
            "is_dashboard_pinned": null,
            "dashboard_pin_id": null,
            "bookmark_id": null,
            "item_rank": null,
            "rank_id": null,
            "type": "Subcategory",
            "user_id": "0",
            "slug": "none",
            "can_update": 1,
            "icon": "/img/category-icons/map.svg",
            "color": "a3c82a",
            "is_pinned": 0,
            "verification_schedule_id": null,
            "resource_type": null,
            "is_answered": null
        },
        {
            "id": 1235338,
            "created_at": "2023-11-17 16:14:24",
            "updated_at": "2023-11-17 16:18:30",
            "title": "Company Org Chart",
            "category_id": 12345,
            "is_dashboard_pinned": null,
            "dashboard_pin_id": null,
            "bookmark_id": null,
            "item_rank": null,
            "rank_id": null,
            "type": "Page",
            "user_id": "12",
            "slug": "company-org-chart",
            "can_update": 1,
            "icon": "none",
            "color": "none",
            "is_pinned": 0,
            "verification_schedule_id": null,
            "resource_type": null,
            "is_answered": null
        },
        {
            "id": 1235337,
            "created_at": "2023-11-17 16:13:25",
            "updated_at": "2023-11-17 16:13:25",
            "title": "Sales Product Overview",
            "category_id": 12345,
            "is_dashboard_pinned": null,
            "dashboard_pin_id": null,
            "bookmark_id": null,
            "item_rank": null,
            "rank_id": null,
            "type": "Page",
            "user_id": "12",
            "slug": "sales-product-overview",
            "can_update": 1,
            "icon": "none",
            "color": "none",
            "is_pinned": 0,
            "verification_schedule_id": null,
            "resource_type": null,
            "is_answered": null
        },
        {
            "id": 17688,
            "created_at": "2023-08-29 14:59:43",
            "updated_at": "2023-08-29 14:59:43",
            "title": "External Link",
            "category_id": 12345,
            "is_dashboard_pinned": null,
            "dashboard_pin_id": null,
            "bookmark_id": null,
            "item_rank": null,
            "rank_id": null,
            "type": "External",
            "user_id": "22",
            "slug": "https://app.tettra.co/teams/tettra/page-ids/1108116",
            "can_update": 1,
            "icon": "https://app.tettra.co/img/icons/file-icon-page-link.svg",
            "color": "none",
            "is_pinned": 0,
            "verification_schedule_id": null,
            "resource_type": "tettra_page",
            "is_answered": null
        }
    ]
}

Error Responses:

401 Unauthorized: Invalid API key.
404 Not Found: Category ID does not exist within the account.