Sign in
latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Projects

Get a project

get/projects/{owner}/{name}

Path parameters

ownerstring required
namestring required

Response

Retrieved

namestring required

The name of the project. Must be unique to a given owner

descriptionstring

A description of the project

publicboolean

Whether or not a project is publicly viewable

idstring required

The project ID

slugstring required

The project name in slug format

Example response

{
  "name": "Project Falcon",
  "description": "I always wanted to have a project called project Falcon",
  "id": "50bb7fe0-8f19-499e-972e-1ebec8af2c71",
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "permissions": {
    "read": true
  },
  "slug": "project-falcon"
}