Developer Resources

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.

Bearer Token Authentication
Scoped access tokens for secure API requests
Optional mTLS
Mutual TLS for enhanced security
IP Allowlists
Restrict access to trusted networks
SCIM & SSO Integration
Seamless identity provider integration
Request Example
curl -X GET https://api.infinize.ai/v1/students \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Core Resources

Students & Enrollments

GET/v1/students
GET/v1/students/{id}
GET/v1/enrollments?term=

Notes & Tasks

POST/v1/notes
POST/v1/tasks

Nudges

POST/v1/nudges

Workflow: draft → approve → send

Plans & Agents

POST/v1/plans/validate
POST/v1/agents/actions

Universal Assistant integration

Webhooks

Subscribe to events and receive real-time notifications when important actions occur.

nudges.sent
plan.validated
agent.actioned
dq.alert
Webhook Payload Example
{
  "event": "nudges.sent",
  "timestamp": "2024-12-03T14:30:00Z",
  "data": {
    "nudge_id": "ndg_abc123",
    "student_id": "stu_xyz789",
    "channel": "email",
    "status": "delivered"
  }
}

Errors & Pagination

Standard JSON Errors

Clear error codes and actionable hints for troubleshooting

Cursor Pagination

Efficient data traversal with cursor-based pagination

?cursor=?limit=

Rate Limits

Retry-after headers and transparent rate limit policies

SDKs & Samples

Postman Collection

Pre-configured API collection for quick testing

Python & Node Samples

Example implementations in popular languages

Webhook Verifier Snippets

Code snippets to verify webhook signatures

Ready to start building?

Request sandbox credentials and start integrating with Infinize API today.