---
id: usage
slug: /usage
title: Usage
toc_max_heading_level: 3
---

import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

## Lists all organizations {#lists-all-organizations}

```
GET https://api.supabase.com/v1/organizations
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Parameters

<ul className="method-list-group">

<li className="method-list-item">
  <h4 className="method-list-item-label">
    <span className="method-list-item-label-name">owned_only</span>
    <span className="method-list-item-label-badge">required</span>
    <span className="method-list-item-validation"></span>
  </h4>
  <div class="method-list-item-description">
    Only list organizations you own
  </div>
</li>

</ul>

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Responses

<Tabs>

<TabItem value="200">

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

```json
{
  "schema": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["id", "name"]
    }
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

<TabItem value="500">

Unexpected error listing organizations

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

</Tabs>

<br />

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

## Creates an organization {#creates-an-organization}

```
POST https://api.supabase.com/v1/organizations
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Body

```json
{
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      }
    },
    "required": ["name"]
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Responses

<Tabs>

<TabItem value="201">

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

```json
{
  "schema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    },
    "required": ["id", "name"]
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

<TabItem value="500">

Unexpected error creating an organization

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

</Tabs>

<br />

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

## Gets all projects that belong to the authenticated user {#gets-all-projects-that-belong-to-the-authenticated-user}

```
GET https://api.supabase.com/v1/projects
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Responses

<Tabs>

<TabItem value="200">

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

```json
{
  "schema": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "organization_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": ["id", "organization_id", "name", "region", "created_at"]
    }
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

</Tabs>

<br />

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

## Creates a project {#creates-a-project}

```
POST https://api.supabase.com/v1/projects
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Body

```json
{
  "schema": {
    "type": "object",
    "properties": {
      "db_pass": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "organization_id": {
        "type": "string"
      },
      "plan": {
        "type": "string",
        "enum": ["free", "pro"]
      },
      "region": {
        "type": "string",
        "enum": [
          "us-east-1",
          "us-west-1",
          "ap-southeast-1",
          "ap-northeast-1",
          "ap-northeast-2",
          "ap-southeast-2",
          "eu-west-1",
          "eu-west-2",
          "eu-central-1",
          "ca-central-1",
          "ap-south-1",
          "sa-east-1"
        ]
      }
    },
    "required": ["db_pass", "name", "organization_id", "plan", "region"]
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

### Responses

<Tabs>

<TabItem value="200">

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

```json
{
  "schema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "organization_id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "region": {
        "type": "string"
      },
      "created_at": {
        "type": "string"
      }
    },
    "required": ["id", "organization_id", "name", "region", "created_at"]
  }
}
```

<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->

</TabItem>

</Tabs>

<br />