GET
/
projects
/
{projectSlug}
curl --request GET \
  --url https://api.dub.co/projects/{projectSlug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "logo": "<string>",
  "usage": 123,
  "usageLimit": 123,
  "plan": "<string>",
  "stripeId": "<string>",
  "billingCycleStart": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "users": [
    {
      "role": "<string>"
    }
  ],
  "domains": [
    {
      "slug": "<string>"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Path Parameters

projectSlug
string
required

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

Response

200 - application/json
id
string

The unique ID of the project.

name
string

The name of the project.

slug
string

The slug of the project.

logo
string | null

The logo of the project.

usage
number
default: 0

The usage of the project.

usageLimit
number
default: 0

The usage limit of the project.

plan
string
default: free

The plan of the project.

stripeId
string | null

The Stripe ID of the project.

billingCycleStart
number | null

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

createdAt
string

The date and time when the project was created.

users
object[]

The role of the authenticated user in the project.

domains
object[]

The domains of the project.