Skip to content
Management API Reference

Gets a specific project that belongs to the authenticated user

get/v1/projects/{ref}

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "id": "lorem",
  "ref": "abcdefghijklmnopqrst",
  "organization_id": "lorem",
  "organization_slug": "tsrqponmlkjihgfedcba",
  "name": "lorem",
  "region": "lorem",
  "created_at": "lorem",
  "status": "INACTIVE",
  "database": {
    "host": "lorem",
    "version": "lorem",
    "postgres_engine": "lorem",
    "release_channel": "lorem"
  }
}