DEVELOPER REFERENCE

The complete API contract.

Every query, mutation, argument, type and permission directive from this release’s GraphQL specification.

Examples and integration guide Download complete GraphQL schema

Search API referenceReference category

497 of 497 definitions

! means required; brackets denote a list. Built-in scalars are ID, String, Int, Float and Boolean. Expand a definition for its exact signature and directives. Follow a related type to clear filters and jump to it.

Schemaschema

Events platform — GraphQL contract v1 (T0). The source of truth for every track. Conventions - Contract-first: tracks implement resolvers against this file; changes go through the owning track's PR and the schema-snapshot gate (QA-GATE-09: Quinn + Lain approval label). - Fail-closed authorisation: every Query and Mutation field declares @auth. A principal holding none of the listed roles gets FORBIDDEN before any resolver runs. There is no OPERATOR role: AF operators have no path to data (SEC-07, SEC-55). - @pii marks contact-class personal data (email, phone, answers). A @pii field carries its own @auth, never lists ANON/HOST/INVESTOR, and is audited on read (SEC-08, SEC-26/27, SEC-38). - @personal marks names and free text about a person (display names, reasons). It carries its own @auth ("role-authorised"), or @personal(self: true) when only the subject may read it; it is read-audited like @pii (T3). Both rules are enforced when the schema boots. - @visibility(class, scope) classifies every field of every company/progress/investor-domain type; it must equal packages/domain/src/authz/registry.ts (QA-GATE-23). The resolver still asks canSee() per field instance (SEC-14): the directive is the declaration, not the check. - @idempotent mutations require the `Idempotency-Key` header (1–255 visible ASCII), scoped per principal; replay returns the original; same key + different payload → IDEMPOTENCY_KEY_REUSED (REQ-REG-02). - @stepUp requires a passkey/TOTP step-up within 5 minutes (REQ-ATT-01, REQ-ADM-13, SEC-09). - The investor role may only execute persisted operations (REQ-VC-13); introspection is off in production (SEC-29); depth and complexity are limited (apps/api/src/limits.ts). - Errors: GraphQL errors with `extensions.code` from ErrorCode. Private resources the caller may not see resolve to null (→ 404 in the web app), never FORBIDDEN, so existence does not leak (SEC-14, REQ-ADM-06). - Time: DateTime is a UTC instant (ISO 8601, Z). LocalDateTime is zone-less wall-clock in the accompanying TimeZone. Durations are integers in minutes, never milliseconds. - Nothing derived, scored, ranked or trended is exposed to founders or investors (REQ-PRG-07).

"""
Events platform — GraphQL contract v1 (T0). The source of truth for every track.

Conventions
- Contract-first: tracks implement resolvers against this file; changes go through the owning
  track's PR and the schema-snapshot gate (QA-GATE-09: Quinn + Lain approval label).
- Fail-closed authorisation: every Query and Mutation field declares @auth. A principal holding
  none of the listed roles gets FORBIDDEN before any resolver runs. There is no OPERATOR role:
  AF operators have no path to data (SEC-07, SEC-55).
- @pii marks contact-class personal data (email, phone, answers). A @pii field carries its own
  @auth, never lists ANON/HOST/INVESTOR, and is audited on read (SEC-08, SEC-26/27, SEC-38).
- @personal marks names and free text about a person (display names, reasons). It carries its
  own @auth ("role-authorised"), or @personal(self: true) when only the subject may read it; it
  is read-audited like @pii (T3). Both rules are enforced when the schema boots.
- @visibility(class, scope) classifies every field of every company/progress/investor-domain
  type; it must equal packages/domain/src/authz/registry.ts (QA-GATE-23). The resolver still
  asks canSee() per field instance (SEC-14): the directive is the declaration, not the check.
- @idempotent mutations require the `Idempotency-Key` header (1–255 visible ASCII), scoped per
  principal; replay returns the original; same key + different payload → IDEMPOTENCY_KEY_REUSED
  (REQ-REG-02).
- @stepUp requires a passkey/TOTP step-up within 5 minutes (REQ-ATT-01, REQ-ADM-13, SEC-09).
- The investor role may only execute persisted operations (REQ-VC-13); introspection is off in
  production (SEC-29); depth and complexity are limited (apps/api/src/limits.ts).
- Errors: GraphQL errors with `extensions.code` from ErrorCode. Private resources the caller may
  not see resolve to null (→ 404 in the web app), never FORBIDDEN, so existence does not leak
  (SEC-14, REQ-ADM-06).
- Time: DateTime is a UTC instant (ISO 8601, Z). LocalDateTime is zone-less wall-clock in the
  accompanying TimeZone. Durations are integers in minutes, never milliseconds.
- Nothing derived, scored, ranked or trended is exposed to founders or investors (REQ-PRG-07).
"""
schema {
  query: Query
  mutation: Mutation
}

Link to this definition Mutation Query

Directive@auth

Fail-closed role gate. Required on every Query/Mutation field.

"Fail-closed role gate. Required on every Query/Mutation field."
directive @auth(roles: [Role!]!) on FIELD_DEFINITION | OBJECT

Link to this definition Role

Directive@pii

Contact-class personal data. Must carry a field-level @auth without ANON, HOST or INVESTOR.

"Contact-class personal data. Must carry a field-level @auth without ANON, HOST or INVESTOR."
directive @pii on FIELD_DEFINITION