TestGorilla

App · 13 actions

Read assessments and results, manage candidate invitations and stages, and update assessment public links.

Actions

ActionWhat it does
Change candidate stageChange candidate stage.
Delete candidate invitationDelete candidate invitation.
Get assessmentGet assessment.
Get candidateGet candidate.
Get personality interpretationGet personality interpretation.
Get test resultGet test result.
Invite candidateInvite candidate.
List assessmentsList assessments.
List candidates in an assessmentList candidates in an assessment.
List test resultsList test results.
Send candidate reminderSend candidate reminder.
Send invitation emailSend invitation email.
Update assessment public linkUpdate assessment public link.

Change candidate stage

Change candidate stage.

Inputs

Candidature idcandidature_idtextRequired
The invitation ID, not the candidate test-taker ID.
StagestagetextRequired
Stage to use.One of: NYE, EVA, IFI, INT, IFT, TTC, REF, OFS, HIR, REJ.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "id": 1,
    "reminder_sent": false,
    "stage": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Delete candidate invitation

Delete candidate invitation.

Inputs

Candidature idcandidature_idtextRequired
The invitation ID, not the candidate test-taker ID.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get assessment

Get assessment.

Inputs

Assessmentassessment_idtextRequired
Pick an assessment or use its ID from an earlier step.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "id": 1,
    "name": "example",
    "public_links": []
  },
  "has_more": false,
  "next_cursor": null
}

Get candidate

Get candidate.

Inputs

Test taker idtest_taker_idtextRequired
The testtaker_id from an invitation or list of candidates.
Candidature idcandidature_idtext
Candidature id to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get personality interpretation

Get personality interpretation.

Inputs

AlgorithmalgorithmtextRequired
Algorithm to use.One of: enneagram, disc, 16_types, big_5, culture_fit.
ScorescoretextRequired
Score to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "personality": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get test result

Get test result.

Inputs

Result idresult_idtextRequired
Result id to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Invite candidate

Invite candidate.

Inputs

Assessmentassessment_idtextRequired
Pick an assessment or use its ID from an earlier step.
EmailemailtextRequired
Email to use.
First namefirst_nametextRequired
First name to use.
Last namelast_nametextRequired
Last name to use.
No emailno_emailtrue/false
No email to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "assessment": 1,
    "email": "example",
    "first_name": "example",
    "id": 1,
    "invitation_uuid": "example",
    "last_name": "example",
    "status": "example",
    "testtaker_id": 1
  },
  "has_more": false,
  "next_cursor": null
}

List assessments

List assessments.

Inputs

Statusstatuslist
Status to use.One or more of: new, active, archived.
Orderingorderingtext
Ordering to use.One of: modified, -modified, name, -name, candidates, -candidates, finished_percentage, -finished_percentage.
Limitlimitnumber
Limit to use.At least 1.
Offsetoffsetnumber
Offset to use.At least 0.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "count": 0,
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List candidates in an assessment

List candidates in an assessment.

Inputs

Assessmentassessment_idtextRequired
Assessment id to use.
Statusstatustext
Status to use.One of: invited, started, completed.
Stagestagetext
Stage to use.One of: NYE, EVA, IFI, INT, IFT, TTC, REF, OFS, HIR, REJ.
Limitlimitnumber
Limit to use.At least 1.
Offsetoffsetnumber
Offset to use.At least 0.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "count": 0,
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List test results

List test results.

Inputs

Assessment idassessment_idtextRequired
Assessment id to use.
Test taker idtest_taker_idtextRequired
Test taker id to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "count": 0,
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Send candidate reminder

Send candidate reminder.

Inputs

Candidature idcandidature_idtextRequired
The invitation ID, not the candidate test-taker ID.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Send invitation email

Send invitation email.

Inputs

Candidature idcandidature_idtextRequired
The invitation ID, not the candidate test-taker ID.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Update assessment public link.

Inputs

Public link uuidpublic_link_uuidtextRequired
Public link uuid to use.
Assessmentassessment_idnumberRequired
Assessment id to use.At least 1.
Activeactivetrue/false
Active to use.
Labellabeltext
Label to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page