API reference - General Validation

Send requests to https://api.generalvalidation.com using the /api/v1 paths recorded in the OpenAPI document. Every request carries a Microsoft Entra token for the General Validation API. Read API authentication before you connect a service or managed identity.

The contract

The complete OpenAPI document is served at https://api.generalvalidation.com/openapi.json to any authenticated Reader. It records each operation’s required role, parameters, request body, and response schema, and it is the schema authority for this API. Tool clients that need a reduced projection of the same document can use https://api.generalvalidation.com/openapi-agent.json. This site does not repeat the per-endpoint contract; retrieve the document with the token your client will use.

Resource groups

Group	What it covers
Organization	The Organization profile and the caller’s effective role. Renaming the Organization is Owner only.
Members and invitations	List members, change roles, remove access, and create, list, or revoke invitations. Owner only. Invitations send no email; the invitee accepts after signing in.
Billing	The effective entitlement for any role. The subscription, billing options, checkout, and the billing portal are Owner only.
Environment reference	The saved reference to the dedicated workspace. Saving or forgetting it is Owner only, and forgetting it does not delete the workspace itself.
Tables, Table Pairs, and Tests	Author and manage Table references, Table Pairs, and Tests. Deleting a Table Pair archives it, as Delete Table Pair does in the app: the pair frees its plan slot, accepts no new Runs or Test edits, and keeps its Runs and Results.
Runs	Read Run history and each Test’s Result metadata. The operations that create a Run and record its submission and summary are the ones the app uses when you click Run validation; a workload cannot submit a Run to Fabric.
Catalog	The fixed catalog of the 12 validation functions.

Authoring and Run operations need Contributor; the OpenAPI document records the role for every operation. What the API does not do, and what it never returns, are described on API and automation.

Conventions

Idempotency: reuse an idempotency key only for an identical retry, and never infer success from a retry alone. See API and automation.
ETags: send the exact ETag you last read on every update that requires one; a stale ETag is refused. See API and automation.
Pagination: collections page with opaque cursors; pass each cursor back unchanged. See API and automation.
Rate limits: honor Retry-After when a response includes it. See API and automation.
Error codes: every error carries a fixed code and a request ID. See API and automation and Error codes.

​The contract

​Resource groups

​Conventions

The contract

Resource groups

Conventions