ExamRoom.AI is a SaaS-based company offering our clients cutting-edge end-to-end examination services.
\nThe ExamRoom APIs allow our clients to integrate with their network for a smooth and quick operating experience. Below is the list of wide-range API endpoints with various functionalities.
\nTo implement the ExamRoom API, you need an environment URL, an API key, and a Secret Key to authenticate.
\nTo generate your API Key and Secret Key, please reach out to our developers at developer@examroom.ai
\nTo access your APIs, log in with the registered credentials.
\nNote: All our APIs are enabled with a Bearer Token Authentication to ensure secure access.
\nAuthentication is done with Bearer Token as defined by ExamRoom.AI Policy.
\nEnter the Username and Password
\nusername: Your ExamRoom.AI account user name
\npassword: Your corresponding ExamRoom.AI account password
\nNote: To create new login credentials, contact our sales/developers.
\nPost login, a cookie is generated storing your credentials and enabling access to all the respective APIs.
\nTo authenticate any particular API, copy the Bearer token from cookies and authenticate with a format Bearer (Bearertoken).
Note: For any authentication failure, a 401 HTTP status code is displayed.
\nExamRoom.AI offers two environments i.e., testing and production. While building your API, please use the testing environment. Once finished, use our production environment.
\nFor any queries or support, please reach out to developer@examroom.ai
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication Process","slug":"authentication-process"},{"content":"Environment URL","slug":"environment-url"},{"content":"Responses","slug":"responses"},{"content":"Common Headers","slug":"common-headers"},{"content":"Variables","slug":"variables"},{"content":"Contact Us","slug":"contact-us"}],"owner":"43319160","collectionId":"8519e8f7-3c56-4c5a-a009-07961fd99cf7","publishedId":"2sB3B7Ntja","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"209E91"},"publishDate":"2025-07-28T11:35:25.000Z"},"item":[{"name":"Manage Organization","item":[{"name":"Register Tenant","id":"ecc21bc7-6b8a-4380-bd57-6adc7f47ab5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"X-Application-Guid","value":"","description":"ApplicationGuid
\n"},{"key":"X-Tenant-Guid","value":"","description":"TenantGuid
\n"},{"key":"X-User-Guid","value":"","description":"UserGuid
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tenantGuid\": \"The Register Tenant API allows the creation of a new tenant within the system. This API is designed to capture detailed information about the tenant, including identification details, contact information, address records, UI theme configuration, and operational settings. The request must be submitted with the necessary headers and a structured JSON payload in the request body.
\nThe JSON payload includes the following components:
\ntenantGuid (string): Unique identifier for the tenant.
tenantName (string): Name of the tenant.
tenantCode (string): A unique code used to reference the tenant.
identifier (string): A unique tenant identifier string.
description (string): A brief description of the tenant.
On successful registration, the API returns a structured response containing the newly created tenant's identifiers and configuration details.
\n","urlObject":{"path":["api","v1","tenants","register-tenant"],"host":["/ClientBFF"],"query":[],"variable":[]}},"response":[{"id":"0143abb9-8950-4066-b9cb-776cb5c01557","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-Application-Guid","value":"","description":"ApplicationGuid"},{"key":"X-Tenant-Guid","value":"","description":"TenantGuid"},{"key":"X-User-Guid","value":"","description":"UserGuid"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"ApplicationGuid
\n"},{"key":"X-Tenant-Guid","value":"","description":"TenantGuid
\n"},{"key":"X-User-Guid","value":"","description":"UserGuid
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tenantGuid\": \"The Update Tenant API allows modification of an existing tenant’s information within the system. This endpoint accepts a structured JSON payload containing updated tenant metadata, contact details, theme settings, address information, and configuration preferences. The API must be called using an HTTP PATCH request along with required headers and authorization credentials.
\nThe JSON payload includes the following components:
\ntenantGuid (string): Unique identifier for the tenant to be updated.
tenantName (string): Updated tenant name.
tenantCode (string): Updated tenant code.
identifier (string): Custom tenant identifier.
description (string): Description of the tenant.
Upon successful update, the API returns a confirmation with the updated tenant details and relevant metadata.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"8519e8f7-3c56-4c5a-a009-07961fd99cf7","id":"8519e8f7-3c56-4c5a-a009-07961fd99cf7","name":"ExamRoom.AI API","type":"collection"}},"urlObject":{"path":["api","v1","tenants","update-tenant"],"host":["/ClientBFF"],"query":[],"variable":[]}},"response":[{"id":"d66bf178-7f9f-439a-83e4-1e0f5c41e4cb","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"X-Application-Guid","value":"","description":"ApplicationGuid"},{"key":"X-Tenant-Guid","value":"","description":"TenantGuid"},{"key":"X-User-Guid","value":"","description":"UserGuid"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"