Retrieve a project

GET 
/projects/:projectSlug

Retrieve a project for the authenticated user.

Request

Path Parameters

projectSlug stringrequired

The slug for the project to retrieve. E.g. for app.zli.bz/acme, the projectSlug is acme.

Responses

200

The retrieved project

application/json

Schema

Schema

id cuid

The unique ID of the project.

name string

The name of the project.

slug string

The slug of the project.

logo stringnullable

The logo of the project.

usage number

The usage of the project.

usageLimit number

The usage limit of the project.

plan string

Default value: free

The plan of the project.

stripeId stringnullable

The Stripe ID of the project.

billingCycleStart numbernullable

The date and time when the billing cycle starts for the project.

createdAt date-time

The date and time when the project was created.

users object[]
The role of the authenticated user in the project.
Array [
role string
The role of the authenticated user in the project.
]
domains object[]
The domains of the project.
Array [
slug string
The domain of the project.
]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "logo": "string",
  "usage": 0,
  "usageLimit": 0,
  "plan": "free",
  "stripeId": "string",
  "billingCycleStart": 0,
  "createdAt": "2024-02-08T04:50:25.544Z",
  "users": [
    {
      "role": "string"
    }
  ],
  "domains": [
    {
      "slug": "string"
    }
  ]
}

Loading...