---
title: "GraphQL API"
method: GET
path: "/api/graphql"
tags: ["GraphQL"]
---

# GraphQL API

`GET /api/graphql`

## Request

- Base URL: `https://passivelogic.com` (the document declares no server; this is the origin it was published from)
- URL: `https://passivelogic.com/api/graphql`
- Auth: one of:
  - API key in header `X-PL-AUTH`
  - API key in header `Authorization: PL-API-KEY`
  - API key in header `PL-API-KEY`
  - HTTP basic
- TypeScript: <https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/graphql/get.ts> (a function with typed inputs; its response is checked against the schema)

Serves the GraphQL API. For more details, see [graphql.org](https://graphql.org/learn/serving-over-http/#get-request)

## Query parameters

- `query` string, required
- `operationName` string, nullable
- `variables` object, nullable

## Response `200`

OK

- GraphQLResult
  - `data` boolean, nullable
  - `errors` GraphQLError[], nullable
    - `path` array[], required
      - integer[]
    - `message` string, required
    - `extensions` object, nullable
    - `locations` SourceLocation[], required
      - `column` integer, required
      - `line` integer, required

---

[API](https://skmtc.dev/passivelogic/apis/passivelogic-http-api.md) - [All operations](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/revisions/28fce63bcdbb?raw)