Working with Categories

A short guide to working with Categories in the Layer API

Introduction

This guide provides an overview of the API endpoints related to Layer categories. It's intended to help developers understand how to retrieve categories and their associated views for specific projects.

📘

Categories are limited to read only requests

Currently, categories data is read only. There are no endpoints currently to create or update categories.

Authentication

All endpoints described in this guide require bearer authentication. Ensure you include a valid bearer token in the Authorization header of your requests. Take a look at our Authentication guide for more details.

Endpoints Overview

• Retrieve All Categories for a Project
• Retrieve a Specific Category within a Project

Example Category Object

JSON

{
  "categories": [
    {
      "createdAt": "2023-08-01T12:00:00Z",
      "count": 5,
      "initials": "IS",
      "instance": "Issue",
      "modelCategory": true,
      "order": 1,
      "name": "Punch List",
      "id": "2efsdc98wjh23v0j",
      "updatedAt": "2023-08-02T12:00:00Z"
    }
  ]
}

Category Parameters

Property	Description	Possible Values
id	Unique ID of the category	String 28e4elfgkj3rfgv0
createdAt	Date the category was created	Timestamp "2023-08-22T12:45:00Z"
count	Number of elements in the category	Number 50
initials	Initials of the category	String IS
instance	Name for an element instance in the category	String Issue
modelCategory	True if the category was created from a model	Boolean true
order	Order of the category in the project	Number 3
name	Name of the category	String Punch List
updatedAt	Date & time the category was last updated	Timestamp "2023-08-22T12:45:00Z"
views	List of views in the category	List [View, View, ...]