Skip to content

Generate TypeScript types

get/v1/projects/{ref}/types/typescript

Returns the TypeScript types of your schema for use with supabase-js.

OAuth scopes

  • database:read

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

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • included_schemas
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "types": "lorem"
}
{
  "type": "object",
  "properties": {
    "types": {
      "type": "string"
    }
  },
  "required": [
    "types"
  ]
}