Introduction

This guide provides an overview of the API endpoints related to Layer projects. It's designed to help developers understand how to retrieve project information effectively and efficiently.

📘
Projects are limited to read only requests
At this time, project data is available through read only requests. The provided endpoints facilitate the retrieval of project details but do not allow creation or modification of projects.

Authentication

All endpoints discussed in this guide require bearer authentication. Make sure to include a valid bearer token in the Authorization header of your requests. For a deeper dive into the authentication process, please consult our Authentication guide.

Endpoints Overview

Example Project Object

{
  "project": {
    "createdAt": "2023-08-22T12:45:00Z",
    "createdBy": "John Doe",
    "company": "Layer Co.",
    "name": "Project Alpha",
    "location": "San Francisco, CA",
    "id": "12345",
    "status": "active",
    "type": "PROJECT",
    "role": "owner"
  }
}

Project Parameters

Property	Description	Possible Values
`id`	Unique ID of the project	String `32rb0v49ejbkjlkj`
`createdAt`	Date & time the project was created	Timestamp `2023-08-22T12:45:00Z`
`createdBy`	Name of the user who created the project	String `John Doe`
`company`	Name of the company that owns the project	String `Layer Co.`
`name`	Name of the project	String `Project Alpha`
`location`	Project location	String`San Francisco, CA`
`status`	Project status	`active` or `archived`
`type`	Project type	`TEMPLATE` or `PROJECT`
`role`	The role of the authenticated user in relation to the project	`owner`, `editor`, `contributor`, or `viewer`