Retrieve Invites

POST

/v3/candidates/testattempts

🔶 API will return list of testInvitationIds which are unique identifiers assigned for each test attempt for all Completed/ Testleft/ Terminated test in provided start and end date time period which is provided by API user.

API client can cross check attempted test in their system using these unique ids.

Note:- Datetime should be in UTC and should follow ISO 8601 format. The time range between StartDateTime and EndDateTime must not exceed 30 days.

Example: 2018-02-15T16:00:00 (15th Feb 2018 04:00:00 PM)

Format: yyyy-MM-ddTHH:mm:ss

Request

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://apiv3.imocha.io/v3/candidates/testattempts?state=completed' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "StartDateTime": "string",
    "EndDateTime": "string"
}'

Response Example

{
    "result": {
        "testAttempts": [
            {
                "testInvitationId": 3178172,
                "extEmployeeId": null,
                "testId": 1154360,
                "name": "Yogesh kadav",
                "email": "[email protected]",
                "invitationtype": "app",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178205,
                "extEmployeeId": null,
                "testId": 1154364,
                "name": "Yogesh kadav",
                "email": "[email protected]",
                "invitationtype": "app",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178206,
                "extEmployeeId": null,
                "testId": 1154360,
                "name": "Yogesh kadav",
                "email": "[email protected]",
                "invitationtype": "app",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178214,
                "extEmployeeId": null,
                "testId": 1154364,
                "name": "Yogesh Kadav",
                "email": "[email protected]",
                "invitationtype": "api",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178225,
                "extEmployeeId": null,
                "testId": 1154360,
                "name": "Yogesh kadav",
                "email": "[email protected]",
                "invitationtype": "app",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178226,
                "extEmployeeId": null,
                "testId": 1154360,
                "name": "Yogesh kadav",
                "email": "[email protected]",
                "invitationtype": "app",
                "teststatus": "Complete"
            },
            {
                "testInvitationId": 3178228,
                "extEmployeeId": null,
                "testId": 1154360,
                "name": "Yogesh Kadav",
                "email": "[email protected]",
                "invitationtype": "api",
                "teststatus": "Complete"
            }
        ]
    },
    "errors": null
}

Modified at 2025-08-06 09:22:47

Process Callbacks

GDPR Data Masking Service