{"info":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","description":"

Complete API collection for AttendX External API v1.0.0

\n

Authentication

\n

All endpoints (except /health and /status) require API key authentication. Include your API key in the Authorization header:

\n
Authorization: Bearer YOUR_API_KEY\n

Set your API key in the collection variable api_key to use it automatically.

\n

Rate Limiting

\n\n

Rate limit information is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

\n

Base URL

\n\n

Request IDs

\n

All responses include an X-Request-ID header for request tracking. Include this ID when reporting issues.

\n

Error Handling

\n

All errors follow a standardized format:

\n
{\n  \"error\": \"Error Type\",\n  \"message\": \"Human-readable message\",\n  \"details\": {}\n}\n
\n

Support

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15425309","collectionId":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","publishedId":"2sB3dSP8n6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-10T23:48:21.000Z"},"item":[{"name":"System","item":[{"name":"Health Check","id":"f3b75127-60e7-4e1b-bcd5-0af2f4f7dc98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/health","description":"

Check API health status and service connectivity. No authentication required.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["health"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3b75127-60e7-4e1b-bcd5-0af2f4f7dc98"},{"name":"API Status","id":"850787b7-c920-41b3-b0b6-f2f42c397c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/status","description":"

Get current API operational status. No authentication required.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["status"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"850787b7-c920-41b3-b0b6-f2f42c397c11"}],"id":"c0fedd25-34c1-40d5-896f-32928c7328cb","_postman_id":"c0fedd25-34c1-40d5-896f-32928c7328cb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Authentication","item":[{"name":"Create API Key","id":"aeb2576e-833a-4314-8314-15176a715941","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My API Key\",\n \"permissions\": [\"students:read\", \"students:write\", \"sessions:read\"],\n \"expiresAt\": null,\n \"ipWhitelist\": []\n}"},"url":"https://api.attendx.org/v1/auth/keys","description":"

Create a new API key with specified permissions. Requires admin authentication.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["auth","keys"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"aeb2576e-833a-4314-8314-15176a715941"},{"name":"List API Keys","id":"0704761a-bfe9-46ff-8361-6740df293181","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/auth/keys","description":"

Get all API keys for the organization. Requires admin authentication.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["auth","keys"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"0704761a-bfe9-46ff-8361-6740df293181"}],"id":"1f7027ea-2bf8-42cb-b257-8c6ca55663c6","_postman_id":"1f7027ea-2bf8-42cb-b257-8c6ca55663c6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Students","item":[{"name":"List Students","id":"46bfcdaf-422c-49db-bc46-46285b7b7c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/students?page=1&limit=100&search=&classId=","description":"

Get paginated list of students with optional filtering. Requires students:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"},{"key":"search","value":""},{"key":"classId","value":""},{"disabled":true,"key":"sortBy","value":"createdAt"},{"disabled":true,"key":"sortOrder","value":"desc"}],"variable":[]}},"response":[],"_postman_id":"46bfcdaf-422c-49db-bc46-46285b7b7c82"},{"name":"Sync Students (Bulk)","id":"d22d122b-c70b-448c-90e1-89bafd11c194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"students\": [\n {\n \"externalId\": \"EXT001\",\n \"uniId\": \"STU001\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"classId\": null,\n \"metadata\": {}\n }\n ],\n \"upsert\": true,\n \"dryRun\": false\n}"},"url":"https://api.attendx.org/v1/students/sync","description":"

Bulk create or update students. Matches by externalId or uniId. Up to 500 students per request. Requires students:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students","sync"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"d22d122b-c70b-448c-90e1-89bafd11c194"},{"name":"Get Student","id":"379db048-32f7-460f-a164-2a7715f58cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/students/:studentId","description":"

Get a single student by ID. Requires students:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students",":studentId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"ae8417a9-83e5-42cb-ad73-b617e3a8bb84","type":"any","value":"uuid-here","key":"studentId"}]}},"response":[],"_postman_id":"379db048-32f7-460f-a164-2a7715f58cb1"},{"name":"Update Student","id":"1feee8d6-c4fb-45ef-a970-73cbd1971169","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe Updated\",\n \"email\": \"john.updated@example.com\",\n \"classId\": null,\n \"metadata\": {}\n}"},"url":"https://api.attendx.org/v1/students/:studentId","description":"

Update student information. Requires students:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students",":studentId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"d82b5bc0-9435-4351-857b-6e8b81283d0b","type":"any","value":"uuid-here","key":"studentId"}]}},"response":[],"_postman_id":"1feee8d6-c4fb-45ef-a970-73cbd1971169"},{"name":"Get Student by External ID","id":"60cca919-b739-43bf-90db-8a04b0b98b41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/students/by-external-id/:externalId","description":"

Find a student by their external system ID. Requires students:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students","by-external-id",":externalId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"56745cf1-431b-497d-a7b9-99151e76d09b","type":"any","value":"EXT001","key":"externalId"}]}},"response":[],"_postman_id":"60cca919-b739-43bf-90db-8a04b0b98b41"},{"name":"Bulk Delete Students","id":"931e9a1e-2964-424f-ac4e-3fc4cb6322c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"studentIds\": [\"uuid1\", \"uuid2\"]\n}"},"url":"https://api.attendx.org/v1/students/bulk-delete","description":"

Delete multiple students by IDs. Up to 100 students per request. Requires students:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["students","bulk-delete"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"931e9a1e-2964-424f-ac4e-3fc4cb6322c1"}],"id":"be6476ba-1772-422d-a3f1-bf23ca94619f","_postman_id":"be6476ba-1772-422d-a3f1-bf23ca94619f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Sessions","item":[{"name":"List Sessions","id":"7e7abd88-97e0-4e4a-89a8-6f58a4a5bc23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/sessions?page=1&limit=100","description":"

Get paginated list of sessions with filtering. Requires sessions:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"},{"disabled":true,"key":"courseId","value":""},{"disabled":true,"key":"classroomId","value":""},{"disabled":true,"key":"status","value":""},{"disabled":true,"key":"startDate","value":""},{"disabled":true,"key":"endDate","value":""}],"variable":[]}},"response":[],"_postman_id":"7e7abd88-97e0-4e4a-89a8-6f58a4a5bc23"},{"name":"Create Session","id":"b072d998-d9c7-473d-b8c9-73e6b9943562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Math 101 - Lecture 1\",\n \"courseId\": \"course-uuid\",\n \"classroomId\": \"classroom-uuid\",\n \"sessionDate\": \"2024-01-15\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"10:30:00\",\n \"latitude\": 6.5244,\n \"longitude\": 3.3792,\n \"geofenceRadiusMeters\": 50,\n \"metadata\": {}\n}"},"url":"https://api.attendx.org/v1/sessions","description":"

Create a new attendance session with QR code. Requires sessions:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"b072d998-d9c7-473d-b8c9-73e6b9943562"},{"name":"Create Bulk Sessions","id":"e0cbedb4-efe0-4515-b38d-16b9e1d55596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sessions\": [\n {\n \"name\": \"Session 1\",\n \"courseId\": \"course-uuid\",\n \"classroomId\": \"classroom-uuid\",\n \"sessionDate\": \"2024-01-15\",\n \"startTime\": \"09:00:00\",\n \"latitude\": 6.5244,\n \"longitude\": 3.3792\n }\n ]\n}"},"url":"https://api.attendx.org/v1/sessions/bulk","description":"

Create multiple sessions in one request (up to 100). Requires sessions:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions","bulk"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0cbedb4-efe0-4515-b38d-16b9e1d55596"},{"name":"Get Session","id":"abd137ac-c732-4604-8245-2b0c94b0fc4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/sessions/:sessionId","description":"

Get a single session by ID. Requires sessions:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions",":sessionId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"54193980-b9a8-488f-9878-b3241e454bd0","type":"any","value":"uuid-here","key":"sessionId"}]}},"response":[],"_postman_id":"abd137ac-c732-4604-8245-2b0c94b0fc4d"},{"name":"Update Session","id":"f06653af-8c2a-4fc3-9c4e-0d472f2eff02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated Session Name\",\n \"status\": \"active\",\n \"endTime\": \"11:00:00\"\n}"},"url":"https://api.attendx.org/v1/sessions/:sessionId","description":"

Update session information. Requires sessions:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions",":sessionId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"a99b7c84-ee35-4fab-a976-d370be43ee09","type":"any","value":"uuid-here","key":"sessionId"}]}},"response":[],"_postman_id":"f06653af-8c2a-4fc3-9c4e-0d472f2eff02"},{"name":"Delete Session","id":"5c463514-3653-4062-b967-6079346653de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.attendx.org/v1/sessions/:sessionId","description":"

Delete a session. Requires sessions:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions",":sessionId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"7e38096a-0bf9-472d-9159-42642d016078","type":"any","value":"uuid-here","key":"sessionId"}]}},"response":[],"_postman_id":"5c463514-3653-4062-b967-6079346653de"},{"name":"End Session","id":"a8455d4b-9c70-4519-971e-19d93f03f08f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.attendx.org/v1/sessions/:sessionId/end","description":"

Mark a session as ended. Requires sessions:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions",":sessionId","end"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"b575170d-b0f2-4300-928d-b49f4239be72","type":"any","value":"uuid-here","key":"sessionId"}]}},"response":[],"_postman_id":"a8455d4b-9c70-4519-971e-19d93f03f08f"},{"name":"Get Session QR Code","id":"62f7ed0f-3ae7-438b-b63a-769c88df6924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/sessions/:sessionId/qr","description":"

Get QR code image for a session. Requires sessions:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["sessions",":sessionId","qr"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"aca8e379-1d66-416b-9984-dfe192b58955","type":"any","value":"uuid-here","key":"sessionId"}]}},"response":[],"_postman_id":"62f7ed0f-3ae7-438b-b63a-769c88df6924"}],"id":"ffc0ee84-0a60-43da-9420-48458baabb6f","_postman_id":"ffc0ee84-0a60-43da-9420-48458baabb6f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Attendance","item":[{"name":"List Attendance Records","id":"abea8230-ea7f-42ff-a837-a73c09015b8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/attendance?page=1&limit=100","description":"

Get paginated attendance records with filtering. Requires attendance:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"},{"disabled":true,"key":"sessionId","value":""},{"disabled":true,"key":"studentId","value":""},{"disabled":true,"key":"status","value":""},{"disabled":true,"key":"startDate","value":""},{"disabled":true,"key":"endDate","value":""}],"variable":[]}},"response":[],"_postman_id":"abea8230-ea7f-42ff-a837-a73c09015b8f"},{"name":"Mark Single Attendance","id":"45fabb96-74cd-4fab-aef2-3edb456a47a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sessionId\": \"session-uuid\",\n \"studentId\": \"student-uuid\",\n \"status\": \"present\",\n \"timestamp\": \"2024-01-15T09:30:00Z\",\n \"lat\": 6.5244,\n \"lon\": 3.3792,\n \"accuracy\": 10\n}"},"url":"https://api.attendx.org/v1/attendance","description":"

Mark a single attendance record. Requires attendance:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"45fabb96-74cd-4fab-aef2-3edb456a47a0"},{"name":"Sync Attendance Records","id":"634e808c-4da4-4cf4-85a0-0b4f25693529","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"records\": [\n {\n \"sessionId\": \"session-uuid\",\n \"studentId\": \"student-uuid\",\n \"status\": \"present\",\n \"timestamp\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}"},"url":"https://api.attendx.org/v1/attendance/sync","description":"

Bulk create or update attendance records. Requires attendance:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance","sync"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"634e808c-4da4-4cf4-85a0-0b4f25693529"},{"name":"Export Attendance (CSV)","id":"a5826b21-b84f-4dfe-91a3-5fefbe67970a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/attendance/export?sessionId=&startDate=&endDate=","description":"

Export attendance records as CSV. Requires attendance:read or reports:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance","export"],"host":["https://api.attendx.org/v1"],"query":[{"key":"sessionId","value":""},{"key":"startDate","value":""},{"key":"endDate","value":""}],"variable":[]}},"response":[],"_postman_id":"a5826b21-b84f-4dfe-91a3-5fefbe67970a"},{"name":"Update Attendance Record","id":"2a5fd706-f8ab-47b2-b317-791a3bdfc69a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"present\",\n \"verificationStatus\": \"verified\",\n \"overrideJustification\": \"Manual correction\"\n}"},"url":"https://api.attendx.org/v1/attendance/:attendanceId","description":"

Update an attendance record. Requires attendance:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance",":attendanceId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"a83be1a9-454e-47b2-bc90-bff14a617124","type":"any","value":"uuid-here","key":"attendanceId"}]}},"response":[],"_postman_id":"2a5fd706-f8ab-47b2-b317-791a3bdfc69a"},{"name":"Delete Attendance Record","id":"63934d97-7e89-4363-89e3-65ef34d3618d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.attendx.org/v1/attendance/:attendanceId","description":"

Delete an attendance record. Requires attendance:write permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["attendance",":attendanceId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"6387298e-425d-44b1-8a05-3b7a0d14fa11","type":"any","value":"uuid-here","key":"attendanceId"}]}},"response":[],"_postman_id":"63934d97-7e89-4363-89e3-65ef34d3618d"}],"id":"a041e0dd-eb48-4630-bf0a-299e5303e91d","_postman_id":"a041e0dd-eb48-4630-bf0a-299e5303e91d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Analytics","item":[{"name":"Attendance Statistics","id":"1ba4aa7a-06a8-4181-850b-f4d73710d6f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/analytics/attendance/stats?startDate=&endDate=&groupBy=day","description":"

Get overall attendance statistics. Requires analytics:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["analytics","attendance","stats"],"host":["https://api.attendx.org/v1"],"query":[{"key":"startDate","value":""},{"key":"endDate","value":""},{"key":"groupBy","value":"day"}],"variable":[]}},"response":[],"_postman_id":"1ba4aa7a-06a8-4181-850b-f4d73710d6f7"},{"name":"Student Attendance Analytics","id":"35ff28f5-9797-4bbe-b731-8d0ba149b6f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/analytics/students/:studentId/attendance?startDate=&endDate=","description":"

Get attendance analytics for a specific student. Requires analytics:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["analytics","students",":studentId","attendance"],"host":["https://api.attendx.org/v1"],"query":[{"key":"startDate","value":""},{"key":"endDate","value":""}],"variable":[{"id":"776213ff-ba7d-4e15-a1db-2a20f840027b","type":"any","value":"uuid-here","key":"studentId"}]}},"response":[],"_postman_id":"35ff28f5-9797-4bbe-b731-8d0ba149b6f8"},{"name":"Class Performance Analytics","id":"fd0e4134-672b-4d2e-b6c6-56c9cdf6f9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/analytics/classes/:classId/performance?startDate=&endDate=","description":"

Get performance analytics for a specific class. Requires analytics:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["analytics","classes",":classId","performance"],"host":["https://api.attendx.org/v1"],"query":[{"key":"startDate","value":""},{"key":"endDate","value":""}],"variable":[{"id":"5f1bc6b4-842f-4259-b0e8-f229be2296e8","type":"any","value":"uuid-here","key":"classId"}]}},"response":[],"_postman_id":"fd0e4134-672b-4d2e-b6c6-56c9cdf6f9e9"},{"name":"API Usage Statistics","id":"2304bc2f-f4fb-4807-9551-5d33d0bf4413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/analytics/api/usage?startDate=&endDate=&groupBy=day","description":"

Get API usage statistics for the current API key. Requires analytics:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["analytics","api","usage"],"host":["https://api.attendx.org/v1"],"query":[{"key":"startDate","value":""},{"key":"endDate","value":""},{"key":"groupBy","value":"day"}],"variable":[]}},"response":[],"_postman_id":"2304bc2f-f4fb-4807-9551-5d33d0bf4413"}],"id":"fbcb48ed-9795-491b-b112-f793dc8f0a54","_postman_id":"fbcb48ed-9795-491b-b112-f793dc8f0a54","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Courses","item":[{"name":"List Courses","id":"e118da2a-780d-4ef4-8256-1843d6fa1d24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/courses?page=1&limit=100&search=","description":"

Get paginated list of courses. Requires courses:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["courses"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"},{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"e118da2a-780d-4ef4-8256-1843d6fa1d24"}],"id":"179e45f8-a99a-4e89-862f-2d4a18d64c68","_postman_id":"179e45f8-a99a-4e89-862f-2d4a18d64c68","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Classes","item":[{"name":"List Classes","id":"0b361269-18cb-43b4-a97d-91fd307be9d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/classes?page=1&limit=100","description":"

Get paginated list of classes. Requires classes:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["classes"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"}],"variable":[]}},"response":[],"_postman_id":"0b361269-18cb-43b4-a97d-91fd307be9d4"}],"id":"82a68695-cf97-453a-941b-539b68246807","_postman_id":"82a68695-cf97-453a-941b-539b68246807","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Classrooms","item":[{"name":"List Classrooms","id":"df3c0acc-5aee-4c6c-bce4-0ffadbffa033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/classrooms?page=1&limit=100","description":"

Get paginated list of classrooms. Requires classrooms:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["classrooms"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"}],"variable":[]}},"response":[],"_postman_id":"df3c0acc-5aee-4c6c-bce4-0ffadbffa033"}],"id":"27626ff0-a918-4175-a160-108031838012","_postman_id":"27626ff0-a918-4175-a160-108031838012","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"List Webhooks","id":"f40f0aae-d6d3-47ef-83ce-24675a657223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/webhooks?page=1&limit=100&active=","description":"

Get paginated list of webhooks. Requires webhooks:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["webhooks"],"host":["https://api.attendx.org/v1"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"100"},{"key":"active","value":""}],"variable":[]}},"response":[],"_postman_id":"f40f0aae-d6d3-47ef-83ce-24675a657223"},{"name":"Create Webhook","id":"155c82ad-363e-4c75-9318-5b7b24cd006f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-app.com/webhooks/attendx\",\n \"events\": [\"student.created\", \"session.created\", \"attendance.marked\"],\n \"active\": true,\n \"metadata\": {}\n}"},"url":"https://api.attendx.org/v1/webhooks","description":"

Create a new webhook subscription. Requires webhooks:manage permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["webhooks"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"155c82ad-363e-4c75-9318-5b7b24cd006f"},{"name":"Get Webhook","id":"851c4ca8-e9e5-4d62-b9d5-4b83dfd353c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/webhooks/:webhookId","description":"

Get a single webhook by ID. Requires webhooks:read permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["webhooks",":webhookId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"9fed08e0-7170-405e-a955-e173d8477bd4","type":"any","value":"uuid-here","key":"webhookId"}]}},"response":[],"_postman_id":"851c4ca8-e9e5-4d62-b9d5-4b83dfd353c5"},{"name":"Update Webhook","id":"16336010-a95c-4bd3-8e64-86408469bf85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-app.com/webhooks/attendx\",\n \"events\": [\"student.created\"],\n \"active\": true\n}"},"url":"https://api.attendx.org/v1/webhooks/:webhookId","description":"

Update webhook configuration. Requires webhooks:manage permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["webhooks",":webhookId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"72ccb1da-cd12-4030-a294-dfd9a5e39d76","type":"any","value":"uuid-here","key":"webhookId"}]}},"response":[],"_postman_id":"16336010-a95c-4bd3-8e64-86408469bf85"},{"name":"Delete Webhook","id":"7f0bfa71-db88-44e9-9704-cb1231d40a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.attendx.org/v1/webhooks/:webhookId","description":"

Delete a webhook. Requires webhooks:manage permission.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["webhooks",":webhookId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"bf9dd5d9-9fd6-436f-bcfe-f000b660a01a","type":"any","value":"uuid-here","key":"webhookId"}]}},"response":[],"_postman_id":"7f0bfa71-db88-44e9-9704-cb1231d40a4a"}],"id":"d2d823d7-e8ae-4e1f-aec8-d296c2ffdd17","_postman_id":"d2d823d7-e8ae-4e1f-aec8-d296c2ffdd17","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}},{"name":"Batch","item":[{"name":"Get Batch Status","id":"17fd53c7-d05d-46ce-a8d6-cec50fe783b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.attendx.org/v1/batch/:batchId","description":"

Get the status of a batch operation.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["batch",":batchId"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"a5a6c9c6-0b6b-429d-91a1-442b3a954a41","type":"any","value":"batch-id-here","key":"batchId"}]}},"response":[],"_postman_id":"17fd53c7-d05d-46ce-a8d6-cec50fe783b1"},{"name":"Cancel Batch Operation","id":"47d1e90a-9655-4557-b4fb-b96e1d68b4a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.attendx.org/v1/batch/:batchId/cancel","description":"

Cancel a pending or processing batch operation.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}},"urlObject":{"path":["batch",":batchId","cancel"],"host":["https://api.attendx.org/v1"],"query":[],"variable":[{"id":"1683a735-9c3d-44d6-9981-a783bad249d7","type":"any","value":"batch-id-here","key":"batchId"}]}},"response":[],"_postman_id":"47d1e90a-9655-4557-b4fb-b96e1d68b4a6"}],"id":"06b8670b-db15-446f-b739-6791b1283b44","_postman_id":"06b8670b-db15-446f-b739-6791b1283b44","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","id":"864d3abe-85f5-4a6a-98b0-26bce4a215e2","name":"AttendX External API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"variable":[{"key":"base_url","value":"https://api.attendx.org/v1","type":"string"},{"key":"api_key","value":"","type":"string"}]}