davila7/claude-code-templates / cli-tool/components/skills/database/using-neon
using-neon
FlaggedGuides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon features, authentication (@neondatabase/auth), PostgREST-style data API (@neondatabase/neon-js), Neon CLI, and Neon's Platform API/SDKs. Use for any Neon-related questions.
references/neon-rest-api/organizations.md
View on GitHub## Overview
This section provides rules for managing organizations, their members, invitations, and organization API keys. Organizations allow multiple users to collaborate on projects and share resources within Neon.
## Manage organizations
### Retrieve organization details
1. Action: Retrieves detailed information about a specific organization.
2. Endpoint: `GET /organizations/{org_id}`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
Example Request:
```bash
curl 'https://console.neon.tech/api/v2/organizations/{org_id}' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### List organization members
1. Action: Retrieves a list of all members belonging to the specified organization.
2. Endpoint: `GET /organizations/{org_id}/members`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
Example Request:
```bash
curl 'https://console.neon.tech/api/v2/organizations/{org_id}/members' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### Retrieve organization member details
1. Action: Retrieves information about a specific member of an organization.
2. Endpoint: `GET /organizations/{org_id}/members/{member_id}`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
- `member_id` (UUID, required): The unique identifier of the organization member.
Example Request:
```bash
curl 'https://console.neon.tech/api/v2/organizations/{org_id}/members/{member_id}' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### Update role for organization member
1. Action: Updates the role of a specified member within an organization.
2. Prerequisite: This action can only be performed by an organization `admin`.
3. Endpoint: `PATCH /organizations/{org_id}/members/{member_id}`
4. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
- `member_id` (UUID, required): The unique identifier of the organization member.
5. Body Parameters:
- `role` (string, required): The new role for the member. Allowed values: `admin`, `member`.
Example: Change a member's role to admin
```bash
curl -X 'PATCH' \
'https://console.neon.tech/api/v2/organizations/{org_id}/members/{member_id}' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"role": "admin"}'
```
### Remove member from organization
1. Action: Removes a specified member from an organization.
2. Prerequisites:
- This action can only be performed by an organization `admin`.
- An admin cannot be removed if they are the only admin left in the organization.
3. Endpoint: `DELETE /organizations/{org_id}/members/{member_id}`
4. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
- `member_id` (UUID, required): The unique identifier of the organization member to remove.
Example Request:
```bash
curl -X 'DELETE' \
'https://console.neon.tech/api/v2/organizations/{org_id}/members/{member_id}' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### Create organization invitations
1. Action: Creates and sends one or more email invitations for users to join a specific organization.
2. Endpoint: `POST /organizations/{org_id}/invitations`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
4. Body Parameters:
`invitations` (array of objects, required): A list of invitations to create.
- `email` (string, required): The email address of the user to invite.
- `role` (string, required): The role the invited user will have. Allowed values: `admin`, `member`.
Example: Invite two users with different roles
```bash
curl -X 'POST' \
'https://console.neon.tech/api/v2/organizations/{org_id}/invitations' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"invitations": [
{
"email": "developer@example.com",
"role": "member"
},
{
"email": "manager@example.com",
"role": "admin"
}
]
}'
```
### List organization invitations
1. Action: Retrieves information about outstanding invitations for the specified organization.
2. Endpoint: `GET /organizations/{org_id}/invitations`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
Example Request:
```bash
curl 'https://console.neon.tech/api/v2/organizations/{org_id}/invitations' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### Create organization API key
1. Action: Creates a new API key for the specified organization. The key can be scoped to the entire organization or limited to a single project within it.
2. Endpoint: `POST /organizations/{org_id}/api_keys`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
4. Body Parameters:
- `key_name` (string, required): A user-specified name for the API key (max 64 characters).
- `project_id` (string, optional): If provided, the API key's access will be restricted to only this project.
5. Authorization: Use a Personal API Key of an organization `admin` to create organization API keys.
Example: Create a project-scoped API key
```bash
curl -X 'POST' \
'https://console.neon.tech/api/v2/organizations/{org_id}/api_keys' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $PERSONAL_API_KEY_OF_ADMIN" \
-H 'Content-Type: application/json' \
-d '{
"key_name": "ci-pipeline-key-for-project-x",
"project_id": "project-id-123"
}'
```
### List organization API keys
1. Action: Retrieves a list of all API keys created for the specified organization.
2. Endpoint: `GET /organizations/{org_id}/api_keys`
3. Note: The response includes metadata about the keys (like `id` and `name`) but does not include the secret key tokens themselves. Tokens are only visible upon creation.
4. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
Example Request:
```bash
curl 'https://console.neon.tech/api/v2/organizations/{org_id}/api_keys' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
### Revoke organization API key
1. Action: Permanently revokes the specified organization API key.
2. Endpoint: `DELETE /organizations/{org_id}/api_keys/{key_id}`
3. Path Parameters:
- `org_id` (string, required): The unique identifier of the organization.
- `key_id` (integer, required): The unique identifier of the API key to revoke. You can obtain this ID by listing the organization's API keys.
Example Request:
```bash
curl -X 'DELETE' \
'https://console.neon.tech/api/v2/organizations/{org_id}/api_keys/{key_id}' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $NEON_API_KEY"
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |