Swush
API

GraphQL

GraphQL endpoint for core resources.

Swush exposes a GraphQL endpoint at:

/api/graphql

Auth

  • Use your web session (cookies) for UI calls.
  • API keys are supported for POST requests (if tokens are enabled).

Example query

query Notes($limit: Int) {
  notes(input: { limit: $limit }) {
    total
    items {
      id
      title
      isPublic
    }
  }
}

Example mutation

mutation CreateNote($input: CreateNoteInput!) {
  createNote(input: $input) {
    id
    title
  }
}

Feature gating

GraphQL respects the same per-user feature controls as REST. If a feature is disabled, queries and mutations for that resource return a forbidden error.

Files

File uploads remain REST-only via /api/v1/upload.

Introspection

Introspection is enabled by default in development. Use your favorite GraphQL client (Altair, Insomnia, Postman) to explore the schema.

On this page