API Documentation

Secure, versioned REST endpoints with webhooks and SCIM support.

Authentication

Bearer tokens with scopes; optional mTLS and IP allowlists. SCIM and SSO integrate with your IdP.

Authorization: Bearer <token>

Core resources

  • GET /v1/students, GET /v1/students/{id}
  • GET /v1/enrollments?term=
  • POST /v1/notes, POST /v1/tasks
  • POST /v1/nudges (draft → approve → send)
  • POST /v1/plans/validate
  • POST /v1/agents/actions (Universal Agent)

Webhooks

Subscribe to events (nudges.sent, plan.validated, agent.actioned, dq.alert).

POST /webhooks/infinize
X-Infinize-Signature: sha256=...
            

Errors & pagination

  • Standard JSON errors with codes and hints
  • Cursor pagination (?cursor=, ?limit=)
  • Rate limits and retry-after headers

SDKs & Samples

  • Postman collection
  • Python & Node samples
  • Webhook verifier snippets
Request developer access