Qualified API Documentation

Base Path

All endpoints have a base path of https://www.qualified.io/api.

Authorization

Authorization is done by passing in an API key to the Authorization header. If your account is on a plan that allows API access then you will be able to find your key by going to Team Settings > Integrations within the Qualified app.

Note: The examples below may use a longer token string than the key you will find within your team account settings.

Note: Make sure to keep your API key safe. Do not expose it through client-side applications.

Parameters

There are a few special conventions used within our API in regards to our parameters:

Casing

Both camel and underscore casing is supported when sending data to the sever. The examples given will use underscore casing for consistency.

Includes

There is a special parameter called "includes", available on most model requests. This parameter will fetch additional relations related to each model and include them within the model's JSON response. For example if you are returning an assessment result and want to include the related solutions, you can include them within a single API call.


Assessment Briefs

Briefs are living report information. They are synced in the background after information related to a assessment is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/assessment_briefs

Request

Route

GET /v1/assessment_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmFjMzVmZDJmODNmZTQ2YjZhNSIsImlkIjoiNWU2MTg2YWMzNWZkMmY4M2ZlNDZiNmE2Iiwic2VjcmV0IjoiNlJyUTN3PT0ifQ.aFHRCZqA6W9vtKqeX95MWTb8Ogp-I8inrzF5p9ErjV0

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentBrief",
  "data": [
    {
      "id": "5e6186ae35fd2f83fe46b6f4",
      "createdAt": "2020-03-05T23:09:34.237Z",
      "updatedAt": "2020-03-05T23:09:34.301Z",
      "teamId": "5e6186ac35fd2f83fe46b6a9",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-03-05T23:09:35.301Z",
      "syncs": 1,
      "assessmentId": "5e6186ac35fd2f83fe46b6b0",
      "title": "Junior JavaScript Engineer #85",
      "labels": null,
      "state": "published",
      "enforcedTimeLimit": null,
      "suggestedEstimatedTime": 6,
      "passingScore": 100,
      "demoData": false,
      "assessmentUpdatedAt": "2020-03-05T23:09:33.037Z",
      "challengesCount": 3,
      "solutionsCount": 18,
      "counts": {
        "total": 6,
        "abandoned": 0,
        "passed": 0,
        "states": {
          "started": 5,
          "submitted": 1
        },
        "closed_reasons": {
          "candidate_submitted": 1
        }
      },
      "assessmentInvitationCounts": {},
      "solutionRisks": {},
      "submissionRate": 16.66666666666666,
      "passRate": 0.0,
      "baselineStats": {
        "score": null,
        "accumulated_seconds": null,
        "accumulated_bg_seconds": null
      },
      "subjectStats": {
        "score": {
          "iqr": 0.0,
          "counts": {
            "total": 6,
            "min": 6,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 6,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 6
          },
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0.0,
            "l_fence": 0.0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0.0,
            "max": 0.0
          }
        },
        "accumulated_seconds": {
          "iqr": 0.0,
          "counts": {
            "total": 6,
            "min": 6,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 6,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 6
          },
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0,
            "l_fence": 0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0,
            "max": 0
          }
        },
        "accumulated_bg_seconds": {
          "iqr": 0.0,
          "counts": {
            "total": 6,
            "min": 6,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 6,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 6
          },
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0,
            "l_fence": 0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0,
            "max": 0
          }
        }
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:09:34.335-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_briefs/:id

Request

Route

GET /v1/assessment_briefs/5e6186ae35fd2f83fe46b700

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmFlMzVmZDJmODNmZTQ2YjZmNSIsImlkIjoiNWU2MTg2YWUzNWZkMmY4M2ZlNDZiNmY2Iiwic2VjcmV0IjoiMVNJQXRBPT0ifQ.CmNgfL7IreRh4DbC2Nu-Klo_zwfWo3riu2-UYkGRcpo

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b035fd2f83fe46b74d",
  "type": "AssessmentBrief",
  "data": {
    "id": "5e6186b035fd2f83fe46b74d",
    "createdAt": "2020-03-05T23:09:36.017Z",
    "updatedAt": "2020-03-05T23:09:36.070Z",
    "teamId": "5e6186ae35fd2f83fe46b6f9",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-03-05T23:09:37.069Z",
    "syncs": 1,
    "assessmentId": "5e6186ae35fd2f83fe46b700",
    "title": "Junior DevOps Developer #86",
    "labels": null,
    "state": "published",
    "enforcedTimeLimit": null,
    "suggestedEstimatedTime": 6,
    "passingScore": 100,
    "demoData": false,
    "assessmentUpdatedAt": "2020-03-05T23:09:34.564Z",
    "challengesCount": 3,
    "solutionsCount": 21,
    "counts": {
      "total": 7,
      "abandoned": 0,
      "passed": 0,
      "states": {
        "started": 4,
        "submitted": 3
      },
      "closed_reasons": {
        "candidate_submitted": 3
      }
    },
    "assessmentInvitationCounts": {},
    "solutionRisks": {},
    "submissionRate": 42.85714285714285,
    "passRate": 0.0,
    "baselineStats": {
      "score": null,
      "accumulated_seconds": null,
      "accumulated_bg_seconds": null
    },
    "subjectStats": {
      "score": {
        "iqr": 0.0,
        "counts": {
          "total": 7,
          "min": 7,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 7,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 7
        },
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0.0,
          "l_fence": 0.0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0.0,
          "max": 0.0
        }
      },
      "accumulated_seconds": {
        "iqr": 0.0,
        "counts": {
          "total": 7,
          "min": 7,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 7,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 7
        },
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0,
          "l_fence": 0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0,
          "max": 0
        }
      },
      "accumulated_bg_seconds": {
        "iqr": 0.0,
        "counts": {
          "total": 7,
          "min": 7,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 7,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 7
        },
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0,
          "l_fence": 0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0,
          "max": 0
        }
      }
    }
  },
  "meta": {
    "timestamp": "2020-03-05T15:09:36.089-08:00",
    "includes": []
  }
}

Assessment Challenge Items

Resources for viewing and configuring which challenges are associated to each assessment.

Create

This endpoint will pass a challenge id to a assessment and return a AssessmentChallengeItem record. If the challenge already exists for the assessment, a 409 will be returned. If a global challenge is passed, a copy of it will be created for the given team and that copy will be used instead.

Endpoint

POST /v1/assessments/:assessment_id/challenge_items/

Parameters

Name Description
assessment_id required base16 ObjectId
data.challenge_id required base16 ObjectId

Request

Route

POST /v1/assessments/5e6186b035fd2f83fe46b756/challenge_items/

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIwMzVmZDJmODNmZTQ2Yjc1NyIsImlkIjoiNWU2MTg2YjAzNWZkMmY4M2ZlNDZiNzU4Iiwic2VjcmV0IjoiUEI5eU9nPT0ifQ.wFlJcP77eYfMwQUHDDVTqDvekbNnJF7-OoFYQqNuHsU

Body

{
  "data": {
    "challenge_id": "5e6186b035fd2f83fe46b75a"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b035fd2f83fe46b760",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5e6186b035fd2f83fe46b760",
    "challengeId": "5e6186b035fd2f83fe46b75a",
    "position": 1,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-03-05T15:09:36.400-08:00",
    "includes": []
  }
}

Update

This endpoint allows you to modify the position. When changing the position, all other items in the list will be adjusted to account for the item's new position.

Endpoint

PUT /v1/assessments/:assessment_id/challenge_items/:id

Parameters

Name Description
assessment_id required base16 ObjectId
id required base16 ObjectId
data.position Position of the item in the list.

Request

Route

PUT /v1/assessments/5e6186b035fd2f83fe46b769/challenge_items/5e6186b035fd2f83fe46b770

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIwMzVmZDJmODNmZTQ2Yjc2YSIsImlkIjoiNWU2MTg2YjAzNWZkMmY4M2ZlNDZiNzZiIiwic2VjcmV0IjoiUU0wS0VRPT0ifQ.pFUWMthTgaQ0DzI6OeEV3YK-6CUJYk3kcb9mY0pgVsM

Body

{
  "data": {
    "position": 2
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b035fd2f83fe46b770",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5e6186b035fd2f83fe46b770",
    "challengeId": "5e6186b035fd2f83fe46b76d",
    "position": 2,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-03-05T15:09:36.701-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessments/:assessment_id/challenge_items/:id

Parameters

Name Description
assessment_id required base16 ObjectId
id required base16 ObjectId

Request

Route

DELETE /v1/assessments/5e6186b035fd2f83fe46b77d/challenge_items/5e6186b035fd2f83fe46b784

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIwMzVmZDJmODNmZTQ2Yjc3ZSIsImlkIjoiNWU2MTg2YjAzNWZkMmY4M2ZlNDZiNzdmIiwic2VjcmV0IjoibWErczR3PT0ifQ.v8dirCU2Jb5s6M6YaKDjRhb3lPxAa4Jf7H7-kioPX5g
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Assessment Invitations

Resources for managing and creating invitations. Invitations are how candidates get explicitly introduced into the system. For private assessments, this is the only way to gain access to take the assessment.

List

Returns all invitations accessible to the current logged in user

Endpoint

GET /v1/assessment_invitations

Request

Route

GET /v1/assessment_invitations

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIxMzVmZDJmODNmZTQ2Yjc4ZCIsImlkIjoiNWU2MTg2YjEzNWZkMmY4M2ZlNDZiNzhlIiwic2VjcmV0IjoiQlNxWkdRPT0ifQ.S1sfRlwRjHZZgvFGT-6f_1iZZw9TFdY0XSvZVV2o6OM

Query Parameters

{}=

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5e6186b135fd2f83fe46b7a2",
      "state": "active",
      "teamCandidateId": "5e6186b135fd2f83fe46b7aa",
      "assessmentId": "5e6186b135fd2f83fe46b7a3",
      "assessmentResultId": "5e6186b135fd2f83fe46b7ae",
      "teamId": "5e6186b135fd2f83fe46b787",
      "teamMemberId": "5e6186b135fd2f83fe46b7ac",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Senior Rails Developer #90",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith137",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5e6186b135fd2f83fe46b7a3?activate=kvVQhOeNiGc9NA.5e6186b135fd2f83fe46b7a9&email=loginidentity137%40example.com&invite=xkBWdVbwprJu8A",
      "invitePracticePath": "/assess/practice-cc?activate=kvVQhOeNiGc9NA.5e6186b135fd2f83fe46b7a9&email=loginidentity137%40example.com&invite=xkBWdVbwprJu8A&returnTo=%2Fassess%2F5e6186b135fd2f83fe46b7a3%3Factivate%3DkvVQhOeNiGc9NA.5e6186b135fd2f83fe46b7a9%26email%3Dloginidentity137%2540example.com%26invite%3DxkBWdVbwprJu8A"
    },
    {
      "id": "5e6186b135fd2f83fe46b7b2",
      "state": "active",
      "teamCandidateId": "5e6186b135fd2f83fe46b7ba",
      "assessmentId": "5e6186b135fd2f83fe46b7b3",
      "assessmentResultId": "5e6186b135fd2f83fe46b7be",
      "teamId": "5e6186b135fd2f83fe46b787",
      "teamMemberId": "5e6186b135fd2f83fe46b7bc",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Senior Front-End Developer #91",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith139",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5e6186b135fd2f83fe46b7b3?activate=c3npY0qPbGSsfw.5e6186b135fd2f83fe46b7b9&email=loginidentity139%40example.com&invite=CG2bzo6YRBivJQ",
      "invitePracticePath": "/assess/practice-cc?activate=c3npY0qPbGSsfw.5e6186b135fd2f83fe46b7b9&email=loginidentity139%40example.com&invite=CG2bzo6YRBivJQ&returnTo=%2Fassess%2F5e6186b135fd2f83fe46b7b3%3Factivate%3Dc3npY0qPbGSsfw.5e6186b135fd2f83fe46b7b9%26email%3Dloginidentity139%2540example.com%26invite%3DCG2bzo6YRBivJQ"
    },
    {
      "id": "5e6186b135fd2f83fe46b7c2",
      "state": "active",
      "teamCandidateId": "5e6186b135fd2f83fe46b7ca",
      "assessmentId": "5e6186b135fd2f83fe46b7c3",
      "assessmentResultId": "5e6186b135fd2f83fe46b7ce",
      "teamId": "5e6186b135fd2f83fe46b787",
      "teamMemberId": "5e6186b135fd2f83fe46b7cc",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Junior Big-Data Engineer #92",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith141",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5e6186b135fd2f83fe46b7c3?activate=EXFrkKzzAORjWA.5e6186b135fd2f83fe46b7c9&email=loginidentity141%40example.com&invite=peAKKO6ZpdrWsw",
      "invitePracticePath": "/assess/practice-cc?activate=EXFrkKzzAORjWA.5e6186b135fd2f83fe46b7c9&email=loginidentity141%40example.com&invite=peAKKO6ZpdrWsw&returnTo=%2Fassess%2F5e6186b135fd2f83fe46b7c3%3Factivate%3DEXFrkKzzAORjWA.5e6186b135fd2f83fe46b7c9%26email%3Dloginidentity141%2540example.com%26invite%3DpeAKKO6ZpdrWsw"
    }
  ],
  "meta": {
    "timestamp": "2020-03-05T15:09:37.950-08:00",
    "includes": []
  }
}

Invite Candidates

The way to create a candidate within the system is to invite them to an assessment.

Endpoint

POST /v1/assessment_invitations/invite_candidates

Parameters

Name Description with_example
data[candidates] required Array true
data[assessment_id] required base16 ObjectId true
data[assigned_team_member_ids] base16 ObjectId[] true
data[labels] String[] true
data[expires_at] Date true
data[reminder_at] Date true
data[custom_message] String true
data[send_invite_to_candidate] Boolean true
data[send_email_to_inviter] Boolean true
data[send_email_to_inviter] Boolean true
data[reopen_submitted] Boolean true
data[apply_day_defaults] Boolean true
data[first_name] First name of candidate, can only be used when single email is passed to candidates array true
data[last_name] Last name of candidate, can only be used when single email is passed to candidates array true

Request

Route

POST /v1/assessment_invitations/invite_candidates

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIyMzVmZDJmODNmZTQ2YjdkYSIsImlkIjoiNWU2MTg2YjIzNWZkMmY4M2ZlNDZiN2RiIiwic2VjcmV0IjoibjBmM3ZRPT0ifQ.tpgLVryE-0eHH4cAfK27L7CesTyoo95a6AVM2r9PNV4

Body

{
  "data": {
    "candidates": [
      "[email protected]"
    ],
    "assessment_id": "5e6186b235fd2f83fe46b7dd",
    "first_name": "George",
    "last_name": "Smith",
    "send_invite_to_candidate": true
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5e6186b235fd2f83fe46b7e5",
      "state": "active",
      "teamCandidateId": "5e6186b235fd2f83fe46b7e0",
      "assessmentId": "5e6186b235fd2f83fe46b7dd",
      "assessmentResultId": "5e6186b235fd2f83fe46b7e1",
      "teamId": "5e6186b235fd2f83fe46b7d4",
      "teamMemberId": "5e6186b235fd2f83fe46b7db",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Junior Web Engineer #93",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "George Smith",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5e6186b235fd2f83fe46b7dd?activate=qwK7tD9OXwUXhQ.5e6186b235fd2f83fe46b7df&email=George%40place.com&invite=x8BfEWbNU9qJzA",
      "invitePracticePath": "/assess/practice-?activate=qwK7tD9OXwUXhQ.5e6186b235fd2f83fe46b7df&email=George%40place.com&invite=x8BfEWbNU9qJzA&returnTo=%2Fassess%2F5e6186b235fd2f83fe46b7dd%3Factivate%3DqwK7tD9OXwUXhQ.5e6186b235fd2f83fe46b7df%26email%3DGeorge%2540place.com%26invite%3Dx8BfEWbNU9qJzA"
    }
  ],
  "meta": {
    "timestamp": "2020-03-05T15:09:38.344-08:00",
    "includes": []
  }
}

Invite Team Members

Allows you to invite a team member to a specific assessment. They will receive an email.

Endpoint

POST /v1/assessment_invitations/invite_team_members

Parameters

Name Description
team_members required Array
assessment_id required base16 ObjectId

Request

Route

POST /v1/assessment_invitations/invite_team_members

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmIyMzVmZDJmODNmZTQ2YjgwNCIsImlkIjoiNWU2MTg2YjIzNWZkMmY4M2ZlNDZiODA1Iiwic2VjcmV0IjoienlaU25nPT0ifQ.1JoERYEdhFA9m-krF7_rqbgxuav6OgJnuPg808qPisw

Body

{
  "data": {
    "team_members": [
      {
        "email": "[email protected]"
      }
    ],
    "assessment_id": "5e6186b235fd2f83fe46b807"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5e6186b335fd2f83fe46b811",
      "state": "active",
      "teamCandidateId": "5e6186b335fd2f83fe46b80c",
      "assessmentId": "5e6186b235fd2f83fe46b807",
      "assessmentResultId": "5e6186b335fd2f83fe46b80d",
      "teamId": "5e6186b235fd2f83fe46b7fe",
      "teamMemberId": "5e6186b235fd2f83fe46b805",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Mid-Level Web Engineer #95",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": true,
      "inviterRole": "owner",
      "invitePath": "/assess/5e6186b235fd2f83fe46b807?activate=0WkLPJkzYBCTnQ.5e6186b335fd2f83fe46b80b&email=George%40place.com&invite=KRhF0e4ix9rvBw",
      "invitePracticePath": "/assess/practice-?activate=0WkLPJkzYBCTnQ.5e6186b335fd2f83fe46b80b&email=George%40place.com&invite=KRhF0e4ix9rvBw&returnTo=%2Fassess%2F5e6186b235fd2f83fe46b807%3Factivate%3D0WkLPJkzYBCTnQ.5e6186b335fd2f83fe46b80b%26email%3DGeorge%2540place.com%26invite%3DKRhF0e4ix9rvBw"
    }
  ],
  "meta": {
    "timestamp": "2020-03-05T15:09:39.244-08:00",
    "includes": []
  }
}

Assessment Result Reviews

Resources for managing the manual reviews left by team members. These reviews are used to provide feedback on the quality of submissions

List

Endpoint

GET /v1/assessment_result_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/assessment_result_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI0MzVmZDJmODNmZTQ2Yjg4MiIsImlkIjoiNWU2MTg2YjQzNWZkMmY4M2ZlNDZiODgzIiwic2VjcmV0IjoiOXYreE5BPT0ifQ.MmV24eUj2-k_0uURd9sPOx0jr4Ke7aPsoyIsL60OxJw

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentResultReview",
  "data": [
    {
      "id": "5e6186b435fd2f83fe46b87e",
      "reviewedById": "5e6186b435fd2f83fe46b880",
      "reviewedByStaff": null,
      "assessmentId": "5e6186b435fd2f83fe46b86f",
      "assessmentResultId": "5e6186b435fd2f83fe46b877",
      "teamCandidateId": "5e6186b435fd2f83fe46b87a",
      "candidateId": "5e6186b435fd2f83fe46b879",
      "rating": 5,
      "feedback": "great!",
      "state": "started",
      "avgQualitySignalScore": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:09:40.945-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_result_reviews/:id

Request

Route

GET /v1/assessment_result_reviews/5e6186b535fd2f83fe46b89f

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI1MzVmZDJmODNmZTQ2Yjg5YyIsImlkIjoiNWU2MTg2YjUzNWZkMmY4M2ZlNDZiODlkIiwic2VjcmV0IjoiRHJFS21BPT0ifQ.nCLl3JCK7yuCIWXy5B_15a_OfWg0JDI66WS6nKk2F-g

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b535fd2f83fe46b89f",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5e6186b535fd2f83fe46b89f",
    "reviewedById": "5e6186b535fd2f83fe46b8a1",
    "reviewedByStaff": null,
    "assessmentId": "5e6186b535fd2f83fe46b88d",
    "assessmentResultId": "5e6186b535fd2f83fe46b895",
    "teamCandidateId": "5e6186b535fd2f83fe46b898",
    "candidateId": "5e6186b535fd2f83fe46b897",
    "rating": 5,
    "feedback": "great!",
    "state": "started",
    "avgQualitySignalScore": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:41.373-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/assessment_result_reviews

Parameters

Name Description
data.assessment_result_id required data.assessment result
data.reviewed_by_id the id of the user who will be doing the assessing. Only need to set if you are inviting someone else
data.rating 1 - 5, for a 3 point system use 1,3 and 5 as your values
data.feedback data.feedback

Request

Route

POST /v1/assessment_result_reviews

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI1MzVmZDJmODNmZTQ2YjhiYSIsImlkIjoiNWU2MTg2YjUzNWZkMmY4M2ZlNDZiOGJiIiwic2VjcmV0IjoiNGJ5RGlBPT0ifQ.07oDidsvMeMKgWBEaxV_cLS_lshJWurqq7SbAtTWS98

Body

{
  "data": {
    "feedback": "super duper",
    "assessment_result_id": "5e6186b535fd2f83fe46b8b3"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b535fd2f83fe46b8bd",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5e6186b535fd2f83fe46b8bd",
    "reviewedById": "5e6186b535fd2f83fe46b8bb",
    "reviewedByStaff": false,
    "assessmentId": "5e6186b535fd2f83fe46b8ab",
    "assessmentResultId": "5e6186b535fd2f83fe46b8b3",
    "teamCandidateId": "5e6186b535fd2f83fe46b8b6",
    "candidateId": "5e6186b535fd2f83fe46b8b5",
    "rating": null,
    "feedback": "super duper",
    "state": "started",
    "avgQualitySignalScore": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:41.830-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/assessment_result_reviews/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/assessment_result_reviews/5e6186b635fd2f83fe46b8d8

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI2MzVmZDJmODNmZTQ2YjhkNSIsImlkIjoiNWU2MTg2YjYzNWZkMmY4M2ZlNDZiOGQ2Iiwic2VjcmV0IjoieXRwbk9BPT0ifQ.MhN7affymbCukyy3EO8QvD4GsDvk_68vvazhtsQPXc0

Body

{
  "data": {
    "rating": 3,
    "feedback": "feedback"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b635fd2f83fe46b8d8",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5e6186b635fd2f83fe46b8d8",
    "reviewedById": "5e6186b635fd2f83fe46b8da",
    "reviewedByStaff": false,
    "assessmentId": "5e6186b535fd2f83fe46b8c6",
    "assessmentResultId": "5e6186b635fd2f83fe46b8ce",
    "teamCandidateId": "5e6186b635fd2f83fe46b8d1",
    "candidateId": "5e6186b635fd2f83fe46b8d0",
    "rating": 3,
    "feedback": "feedback",
    "state": "started",
    "avgQualitySignalScore": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:42.405-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessment_result_reviews/:id

Request

Route

DELETE /v1/assessment_result_reviews/5e6186b635fd2f83fe46b8f6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI2MzVmZDJmODNmZTQ2YjhmMyIsImlkIjoiNWU2MTg2YjYzNWZkMmY4M2ZlNDZiOGY0Iiwic2VjcmV0IjoicHYvVFh3PT0ifQ.cylHliFW2__cFU09yCEOPScPUARAFuMz6860DuyWg8c
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Assessment Results

List

Endpoint

GET /v1/assessment_results

Parameters

Name Description
includes Valid values are: team_candidate, team, assessment, solutions, challenge
order_by ie: "created_by DESC".
page Default = 1
assessment_id Also reachable via /assessments/:assessment_id/assessment_results
candidate_id Also reachable via /candidates/:candidate_id/assessment_results

Request

Route

GET /v1/assessment_results

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI3MzVmZDJmODNmZTQ2YjkyNCIsImlkIjoiNWU2MTg2YjczNWZkMmY4M2ZlNDZiOTI1Iiwic2VjcmV0IjoiNzM4Uzl3PT0ifQ.V7O_EwYzQTxUWiIhYiAZdDU2ySFx-MmwfhnUcJzmOCU

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentResult",
  "data": [
    {
      "id": "5e6186b735fd2f83fe46b91e",
      "assessmentId": "5e6186b735fd2f83fe46b919",
      "candidateId": "5e6186b635fd2f83fe46b8fb",
      "teamCandidateId": "5e6186b735fd2f83fe46b91f",
      "teamId": "5e6186b735fd2f83fe46b8fe",
      "state": "started",
      "createdAt": "2020-03-05T23:09:43.334Z",
      "updatedAt": "2020-03-05T23:09:43.334Z",
      "startedAt": "2020-03-05T23:09:43.333Z",
      "invitedAt": null,
      "submittedAt": null,
      "submittingAt": null,
      "openedAt": null,
      "originalOpenedAt": null,
      "originalStartedAt": null,
      "originalSubmittedAt": null,
      "dryRun": false,
      "candidateRemarks": null,
      "score": null,
      "closedReason": null,
      "redirectUrl": null,
      "submissionMessage": null,
      "nextAssessmentId": null,
      "totalSubmissionSeconds": null,
      "totalOriginalSubmissionSeconds": null,
      "accumulatedSeconds": 0,
      "enforcedTimeLimit": null,
      "timerExpiresIn": null,
      "wallTimeSinceStart": 0,
      "reopenedById": null,
      "activeTimedSolutionId": null,
      "isActiveInteractSession": false,
      "candidateName": "Joe Smith177",
      "candidateEmail": "[email protected]",
      "candidatePhone": null,
      "interviewerIds": [],
      "activeInterviewerIds": [],
      "abandoned": false,
      "workflowName": null,
      "isInteractSession": false,
      "challengeItems": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:09:43.469-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_results/:id

Parameters

Name Description
id base64 or base16 ObjectId
includes Valid values: team_candidate, team, assessment, solutions, challenge

Request

Route

GET /v1/assessment_results/5e6186b835fd2f83fe46b979

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI4MzVmZDJmODNmZTQ2Yjk1NSIsImlkIjoiNWU2MTg2YjgzNWZkMmY4M2ZlNDZiOTU2Iiwic2VjcmV0IjoiczBQQXh3PT0ifQ.mQTkfazjbLnFhwFPkFnibW0YakJZL9s0r1g1AEepBDw

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186b835fd2f83fe46b979",
  "type": "AssessmentResult",
  "data": {
    "id": "5e6186b835fd2f83fe46b979",
    "assessmentId": "5e6186b835fd2f83fe46b974",
    "candidateId": "5e6186b835fd2f83fe46b956",
    "teamCandidateId": "5e6186b835fd2f83fe46b97a",
    "teamId": "5e6186b835fd2f83fe46b959",
    "state": "started",
    "createdAt": "2020-03-05T23:09:44.595Z",
    "updatedAt": "2020-03-05T23:09:44.595Z",
    "startedAt": "2020-03-05T23:09:44.595Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": null,
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": null,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith195",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:44.699-08:00",
    "includes": []
  }
}

Download

Returns a downloadable PDF report, only available if option is enabled on your subscription

Endpoint

GET /v1/assessment_results/:id/report_url

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5e6186ba35fd2f83fe46b9f9/report_url

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmI5MzVmZDJmODNmZTQ2YjlkNSIsImlkIjoiNWU2MTg2YmEzNWZkMmY4M2ZlNDZiOWQ2Iiwic2VjcmV0IjoiUGREcE93PT0ifQ.D1Phj6yD01jZ8LhfhGhGi0cdOtXto7Ixfa8URfILqv8

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "url": "https://localhost:3001/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVlNjE4NmJhMzVmZDJmODNmZTQ2YjlmOSIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWU2MTg2YmEzNWZkMmY4M2ZlNDZiOWQ5In0.7R6puZr5AbKZLKDI86wMbtyzGzJfcvYwZKZfsstvseI",
  "pdf": "https://localhost:3001/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVlNjE4NmJhMzVmZDJmODNmZTQ2YjlmOSIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWU2MTg2YmEzNWZkMmY4M2ZlNDZiOWQ5In0.7R6puZr5AbKZLKDI86wMbtyzGzJfcvYwZKZfsstvseI"
}

Submit

Submits an assessment to be reviewed/screened by the company/team.

Endpoint

PUT /v1/assessment_results/:id/submit

Request

Route

PUT /v1/assessment_results/5e6186bb35fd2f83fe46ba65/submit

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmJiMzVmZDJmODNmZTQ2YmE0MSIsImlkIjoiNWU2MTg2YmIzNWZkMmY4M2ZlNDZiYTQyIiwic2VjcmV0IjoiTTFPdHhnPT0ifQ.aAMDF3kIq21INqv-_jE2LoR4vDYmIufKeCkkwPRYsmA

Body

{}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186bb35fd2f83fe46ba65",
  "type": "AssessmentResult",
  "data": {
    "id": "5e6186bb35fd2f83fe46ba65",
    "assessmentId": "5e6186bb35fd2f83fe46ba60",
    "candidateId": "5e6186bb35fd2f83fe46ba42",
    "teamCandidateId": "5e6186bb35fd2f83fe46ba66",
    "teamId": "5e6186bb35fd2f83fe46ba45",
    "state": "submitting",
    "createdAt": "2020-03-05T23:09:47.725Z",
    "updatedAt": "2020-03-05T23:09:47.839Z",
    "startedAt": "2020-03-05T23:09:47.725Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "2020-03-05T23:09:47.835Z",
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": "candidate_submitted",
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "totalSubmissionSeconds": 0.110212,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith237",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:48.004-08:00",
    "includes": []
  }
}

Unsubmit

Undos the assessment result submission so that the candidate can make changes

Endpoint

PUT /v1/assessment_results/:id/unsubmit

Request

Route

PUT /v1/assessment_results/5e6186bd35fd2f83fe46bad3/unsubmit

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmJkMzVmZDJmODNmZTQ2YmFjYyIsImlkIjoiNWU2MTg2YmQzNWZkMmY4M2ZlNDZiYWNkIiwic2VjcmV0IjoiUmpScTNnPT0ifQ._eVrjB-IVf-70KAs5umhSnB9jJjU54bCW9JO4bsBjfc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186bd35fd2f83fe46bad3",
  "type": "AssessmentResult",
  "data": {
    "id": "5e6186bd35fd2f83fe46bad3",
    "assessmentId": "5e6186bd35fd2f83fe46bacb",
    "candidateId": "5e6186bd35fd2f83fe46bac2",
    "teamCandidateId": "5e6186bd35fd2f83fe46bad4",
    "teamId": "5e6186bd35fd2f83fe46bac5",
    "state": "opened",
    "createdAt": "1970-01-01T03:58:00.418Z",
    "updatedAt": "2020-03-05T23:09:49.521Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T01:40:00.418Z",
    "openedAt": "2020-03-05T23:09:49.514Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2020-03-05T23:09:49.424Z",
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": "5e6186bd35fd2f83fe46bacd",
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith261",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-03-05T15:09:49.554-08:00",
    "includes": []
  }
}

Assessment Templates

Resources for viewing and importing pre-built assessment templates

List

Endpoint

GET /v1/assessment_templates

Request

Route

GET /v1/assessment_templates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmJlMzVmZDJmODNmZTQ2YmIyYyIsImlkIjoiNWU2MTg2YmUzNWZkMmY4M2ZlNDZiYjJkIiwic2VjcmV0IjoiN2twWThnPT0ifQ.LbWyZ4cSAbeFE5Mwm4j2O3s-CidHO-vpAeUJHveI0LQ

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5e6186bd35fd2f83fe46bae0",
      "title": "Mid-Level Django Engineer #115",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186bd35fd2f83fe46bada",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Aperiam et debitis soluta non. Magnam at aut cumque quibusdam beatae. Aut nesciunt perspiciatis est beatae vitae est.",
      "challengeItems": [
        {
          "id": "5e6186bd35fd2f83fe46bae7",
          "challengeId": "5e6186bd35fd2f83fe46bae4",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46bae4",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Light Algorithm #130",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.768Z",
            "createdAt": "2020-03-05T23:09:49.778Z",
            "updatedAt": "2020-03-05T23:09:49.778Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46bae5",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46bae6",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "LjH5tR0Q4HZSjMe/w4kV4qwdPicTnOoZcxVPtOg3bM0=\n--get0Jyqo20I75o63GKQyyw==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186bd35fd2f83fe46baeb",
          "challengeId": "5e6186bd35fd2f83fe46bae8",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46bae8",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Insane Game #131",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.828Z",
            "createdAt": "2020-03-05T23:09:49.832Z",
            "updatedAt": "2020-03-05T23:09:49.832Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46bae9",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46baea",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "3sczXQCB/WFFIFFZ748C41Mm9/l06tigSe4goCBVCf8=\n--7F04Bab7Ogq0br/hcw2LMQ==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186bd35fd2f83fe46baef",
          "challengeId": "5e6186bd35fd2f83fe46baec",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46baec",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Large Methods #132",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.850Z",
            "createdAt": "2020-03-05T23:09:49.855Z",
            "updatedAt": "2020-03-05T23:09:49.855Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46baed",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46baee",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "tRCQNJryJ5nOluYSUy+cDS+yV9HNuGhZwds6pCj4E3I=\n--PcR+BwbAADaAhex9kAim5g==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Dolorum molestiae quia nulla. Exercitationem error id quis non veritatis corporis animi. Aspernatur quia magnam.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5e6186bd35fd2f83fe46baf0",
      "title": "Senior Full-Stack Developer #116",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186bd35fd2f83fe46bada",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Occaecati aliquid culpa aut laboriosam vitae. A hic modi sed. Cumque omnis quibusdam perspiciatis soluta. Quia et exercitationem. Repellat dolores veniam illo et.",
      "challengeItems": [
        {
          "id": "5e6186bd35fd2f83fe46baf4",
          "challengeId": "5e6186bd35fd2f83fe46baf1",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46baf1",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Utility Substring #133",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.886Z",
            "createdAt": "2020-03-05T23:09:49.890Z",
            "updatedAt": "2020-03-05T23:09:49.890Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46baf2",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46baf3",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "zIt+v9dXDKa3vTblEvl8ThjryuO7dj6oLR9304Tqne0=\n--j/DhBhXzurlFMZe/KHYe5w==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186bd35fd2f83fe46baf8",
          "challengeId": "5e6186bd35fd2f83fe46baf5",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46baf5",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Node Objects #134",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.916Z",
            "createdAt": "2020-03-05T23:09:49.921Z",
            "updatedAt": "2020-03-05T23:09:49.921Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46baf6",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46baf7",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "fnZGxN6+lBcTXIx55Z73/NnUuWfxt+IShlXcDiFULUQ=\n--CuaAMdrPAUYIPfYkDJ5Fog==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186bd35fd2f83fe46bafc",
          "challengeId": "5e6186bd35fd2f83fe46baf9",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46baf9",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Greedy Sorting #135",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.940Z",
            "createdAt": "2020-03-05T23:09:49.956Z",
            "updatedAt": "2020-03-05T23:09:49.956Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46bafa",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46bafb",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "d6eaRXlhWB5E4XfY/EqYzhZTNdvrNl2Ynw/+cZSrisM=\n--slDtzz1ZDsbxjnlMSi5Fkw==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Occaecati nihil sed libero quibusdam impedit eius quia. Consequatur reprehenderit in ut quos. Facere pariatur necessitatibus voluptate tempora ut velit impedit. Qui adipisci ab minima molestias vel iusto.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5e6186bd35fd2f83fe46bafd",
      "title": "Junior Mobile Developer #117",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186bd35fd2f83fe46bada",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Eum assumenda aut quas quibusdam voluptatibus cumque autem. Ipsam atque fuga. Molestiae sunt nam sint mollitia odit at. Necessitatibus magni distinctio aperiam sit nihil. Ullam est repudiandae.",
      "challengeItems": [
        {
          "id": "5e6186be35fd2f83fe46bb01",
          "challengeId": "5e6186bd35fd2f83fe46bafe",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186bd35fd2f83fe46bafe",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Balanced Objects #136",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:49.988Z",
            "createdAt": "2020-03-05T23:09:49.993Z",
            "updatedAt": "2020-03-05T23:09:49.993Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186bd35fd2f83fe46baff",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186bd35fd2f83fe46bb00",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "ECWxZwG1/pOexFqkNULFoo+BfBuh6xdOlZ+WCXAmbZ4=\n--SMwRxD4BPF0YgElVd9+HRw==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb05",
          "challengeId": "5e6186be35fd2f83fe46bb02",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb02",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Value Solution #137",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.016Z",
            "createdAt": "2020-03-05T23:09:50.021Z",
            "updatedAt": "2020-03-05T23:09:50.021Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb03",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb04",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "lwheSBLz/3sKsssRQoJO6uOP9vG843w/6n+A9NrckvE=\n--s2oILMi5jYoZcF4wiSDJBw==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb09",
          "challengeId": "5e6186be35fd2f83fe46bb06",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb06",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Polymorphic Regex #138",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.039Z",
            "createdAt": "2020-03-05T23:09:50.043Z",
            "updatedAt": "2020-03-05T23:09:50.043Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb07",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb08",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "yX6ZYoZ7XOZx4Q9sdPpPn+du77R8xGJ9zIr9i8DCr90=\n--V4+HGDdGyyEYi4oW7B0H5Q==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Quaerat voluptas facilis. Nulla itaque assumenda dolorem. Ratione vel repudiandae. Eligendi et et fugit ex voluptatum dolorum. At totam fugit et blanditiis.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5e6186be35fd2f83fe46bb0a",
      "title": "Junior Django Developer #118",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186bd35fd2f83fe46bada",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Aut velit veniam adipisci neque sit ex. Doloremque deserunt sint doloribus quam ut inventore. Illum tenetur quisquam dolores labore qui et. Eligendi ipsa odit nihil veritatis. Qui et recusandae ea voluptatibus nam eum.",
      "challengeItems": [
        {
          "id": "5e6186be35fd2f83fe46bb0e",
          "challengeId": "5e6186be35fd2f83fe46bb0b",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb0b",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Value Algorithm #139",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.072Z",
            "createdAt": "2020-03-05T23:09:50.077Z",
            "updatedAt": "2020-03-05T23:09:50.077Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb0c",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb0d",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "VdcWuAxYZHbwWr6U8ekYJTcXAdFcHs50wtry2hlUqzM=\n--kj4O5ZkgZoLmijncckNeDQ==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb12",
          "challengeId": "5e6186be35fd2f83fe46bb0f",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb0f",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Value Sequence #140",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.101Z",
            "createdAt": "2020-03-05T23:09:50.105Z",
            "updatedAt": "2020-03-05T23:09:50.105Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb10",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb11",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "F0XvIvSrfrsiDRXP5UAABUm4oLDJ4hrPCzxN5IQPprM=\n--o1wu6oJu/1sLz44EiT94+w==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb16",
          "challengeId": "5e6186be35fd2f83fe46bb13",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb13",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Repeated Class #141",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.123Z",
            "createdAt": "2020-03-05T23:09:50.128Z",
            "updatedAt": "2020-03-05T23:09:50.128Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb14",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb15",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "D/B3ad4dTHLV9x/r8lAek6cKSDQ6PS7G6TTW/VlpH1I=\n--9lNlE7UEYiitj6ksQSrASg==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Officia numquam qui et vero. Porro perferendis quos qui. Explicabo eveniet animi saepe. Provident a ipsa quae amet fugiat itaque est.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5e6186be35fd2f83fe46bb17",
      "title": "Junior Ruby Engineer #119",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186bd35fd2f83fe46bada",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Ratione quam rerum maiores ipsum ea asperiores omnis. Ut pariatur consequatur ut numquam vitae itaque est. Rerum repellendus deleniti vel eligendi. Labore nobis quo soluta nihil. Aliquid impedit facere non modi id vitae.",
      "challengeItems": [
        {
          "id": "5e6186be35fd2f83fe46bb1b",
          "challengeId": "5e6186be35fd2f83fe46bb18",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb18",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Magic Helper #142",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.158Z",
            "createdAt": "2020-03-05T23:09:50.163Z",
            "updatedAt": "2020-03-05T23:09:50.163Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb19",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb1a",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "kjXuf24IGBNdtsZJ2r0SFGXSzStQObfllBCa6x3Pe3k=\n--cp1rAjh3U86rZ0/sBR8plQ==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb1f",
          "challengeId": "5e6186be35fd2f83fe46bb1c",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb1c",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Functional Search #143",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.190Z",
            "createdAt": "2020-03-05T23:09:50.194Z",
            "updatedAt": "2020-03-05T23:09:50.194Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb1d",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb1e",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "qbvyhA00VW1si5cKRKPy3EUn5RUlCsp5BJI57zKpVXE=\n--Svwb/TKq3acDbkNDs4k/Qw==--u"
              }
            ]
          }
        },
        {
          "id": "5e6186be35fd2f83fe46bb23",
          "challengeId": "5e6186be35fd2f83fe46bb20",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5e6186be35fd2f83fe46bb20",
            "$type": "CodeChallenge",
            "teamId": "5e6186bd35fd2f83fe46bada",
            "createdById": "5e6186bd35fd2f83fe46bae2",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Custom Algorithm #144",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-03-05T23:09:50.215Z",
            "createdAt": "2020-03-05T23:09:50.221Z",
            "updatedAt": "2020-03-05T23:09:50.221Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5e6186be35fd2f83fe46bb21",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5e6186be35fd2f83fe46bb22",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "zeig2fwxu23nSOLcKGIFPyhCeRN75ra3c1izaTd7lqM=\n--RIfxKYsygSZqwqGSgpBOqA==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Doloremque voluptatibus sit voluptatem occaecati corrupti perferendis deserunt. Quia odit quod omnis. Ipsum asperiores repudiandae maiores. Deserunt dolores velit aut.",
      "demoLandingOrder": 1000
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2020-03-05T15:09:50.778-08:00",
    "includes": [
      "challenge_items.challenge"
    ]
  }
}

Import

Endpoint

PUT /v1/assessment_templates/:id/import

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessment_templates/5e6186c035fd2f83fe46bbb4/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmMwMzVmZDJmODNmZTQ2YmMwMCIsImlkIjoiNWU2MTg2YzAzNWZkMmY4M2ZlNDZiYzAxIiwic2VjcmV0Ijoiak5yUkdRPT0ifQ.fAR7WgkOJ2lXAdjKt6aqaAqzP13BKdeOQcf_Fgk_N_Q
Content-Type: application/x-www-form-urlencoded

Body

data[title]=Assessment+Title

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c035fd2f83fe46bc15",
  "type": "Assessment",
  "data": {
    "id": "5e6186c035fd2f83fe46bc15",
    "title": "Assessment Title",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c035fd2f83fe46bbfa",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 6,
    "copiedFromId": "5e6186c035fd2f83fe46bbb4",
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Aut excepturi est temporibus architecto est porro. Repudiandae sed magni odio facere. Est eaque ut odit. Sit rerum aut.",
    "challengeItems": [
      {
        "id": "5e6186c035fd2f83fe46bc25",
        "challengeId": "5e6186c035fd2f83fe46bc17",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5e6186c035fd2f83fe46bc26",
        "challengeId": "5e6186c035fd2f83fe46bc1c",
        "position": 2,
        "disabledLanguages": []
      },
      {
        "id": "5e6186c035fd2f83fe46bc27",
        "challengeId": "5e6186c035fd2f83fe46bc21",
        "position": 3,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Dolorem eveniet veniam voluptas est non eos. Ut mollitia quas quam aut consequatur rerum harum. Temporibus laudantium et expedita beatae. Reprehenderit quas eos vero nemo suscipit et.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-03-05T23:09:52.962Z",
    "archivedAt": null,
    "createdAt": "2020-03-05T23:09:52.958Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c135fd2f83fe46bc29"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c035fd2f83fe46bc28",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:53.003-08:00",
    "includes": []
  }
}

Assessments

List

Endpoint

GET /v1/assessments

Parameters

Name Description
includes Valid values are: team, created_by, assessment_results, challenge
order_by ie: "title DESC"
page Default = 1

Request

Route

GET /v1/assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmMyMzVmZDJmODNmZTQ2YmM5OCIsImlkIjoiNWU2MTg2YzIzNWZkMmY4M2ZlNDZiYzk5Iiwic2VjcmV0Ijoibzgwdk1BPT0ifQ.VqTJL6BhLOzkbIlijoHgSD6ktuKiuzBkaPPqBaQ2Qgg

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5e6186c235fd2f83fe46bc83",
      "title": "Senior Back-End Engineer #135",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5e6186c235fd2f83fe46bc7d",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 2,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": false,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Quod officiis laudantium provident fugiat. Aut in tempore dignissimos non qui. Id quia quis. Iure voluptatem sunt perspiciatis numquam.",
      "challengeItems": [
        {
          "id": "5e6186c235fd2f83fe46bc8a",
          "challengeId": "5e6186c235fd2f83fe46bc87",
          "position": 1,
          "disabledLanguages": []
        }
      ],
      "activeAssessmentResultsCount": 2,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Nesciunt id saepe sit rerum tenetur enim. Quia inventore earum. Vel ut vel molestias aut voluptatem voluptas. Quae ut aut. Optio possimus ad cupiditate quia totam.",
      "demoLandingOrder": 1000,
      "publishedAt": "2020-03-05T23:09:54.343Z",
      "archivedAt": null,
      "createdAt": "2020-03-05T23:09:54.388Z",
      "assessmentResultsSummary": {
        "_id": "5e6186c235fd2f83fe46bc8f",
        "all": 2,
        "started": 2
      },
      "labels": null,
      "notificationScheme": null,
      "defaultExpirationDays": null,
      "defaultReminderDays": null,
      "minReviewsBeforeConsideredReviewed": 1,
      "defaultAssignedTeamMemberIds": [],
      "defaultTeamCandidateLabels": null,
      "assignmentTeamMemberIds": [],
      "redirectUrl": null,
      "webhookUrl": null,
      "submissionMessage": null,
      "assignmentLabels": null,
      "assignmentRole": null,
      "workflowPaths": [],
      "bambooConfig": {
        "id": "5e6186c235fd2f83fe46bc9b",
        "jobId": null,
        "resultStateTriggers": null,
        "candidateStateTriggers": null,
        "sendStatus": null
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:09:54.742-08:00",
    "includes": []
  }
}

Get

Returns assessment for both authenticated and unauthenticated users. Only admins and team members can see unpublished assessments.

Endpoint

GET /v1/assessments/:id

Parameters

Name Description
id base16 ObjectId
includes Valid values are: team, challenge, created_by

Request

Route

GET /v1/assessments/5e6186c235fd2f83fe46bca4

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c235fd2f83fe46bca4",
  "type": "Assessment",
  "data": {
    "id": "5e6186c235fd2f83fe46bca4",
    "title": "Senior Mobile Developer #136",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c235fd2f83fe46bc9e",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Et nihil quas. Aut quia perspiciatis itaque eaque quae. Dolorem numquam hic ut. Sit consectetur inventore rerum qui fugiat. Eligendi vero eaque cumque unde explicabo quis.",
    "challengeItems": [
      {
        "id": "5e6186c335fd2f83fe46bcab",
        "challengeId": "5e6186c335fd2f83fe46bca8",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:55.342-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/assessments

Parameters

Name Description
data.title required data.title
data.summary data.summary
data.purpose data.purpose

Request

Route

POST /v1/assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM0MzVmZDJmODNmZTQ2YmNlNCIsImlkIjoiNWU2MTg2YzQzNWZkMmY4M2ZlNDZiY2U1Iiwic2VjcmV0Ijoic2xWdStBPT0ifQ.nTtLcaioTftnwp2vfE-KqZS6uqnADavqagD8rem7TYs
Content-Type: application/x-www-form-urlencoded

Body

data[title]=Angular+Developer

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c435fd2f83fe46bcf8",
  "type": "Assessment",
  "data": {
    "id": "5e6186c435fd2f83fe46bcf8",
    "title": "Angular Developer",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c435fd2f83fe46bcdd",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": null,
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": null,
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-03-05T23:09:56.798Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c435fd2f83fe46bcfa"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c435fd2f83fe46bcf9",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:56.843-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/assessments/:id

Parameters

Name Description
id base16 ObjectId
data.title data.title
data.summary data.summary
data.purpose data.purpose
data.labels Array of labels

Request

Route

PUT /v1/assessments/5e6186c435fd2f83fe46bd03

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM0MzVmZDJmODNmZTQ2YmQwNCIsImlkIjoiNWU2MTg2YzUzNWZkMmY4M2ZlNDZiZDA1Iiwic2VjcmV0IjoiK0toeWh3PT0ifQ.f2CdpZ0zLtJ2zNK5wOXUYcNdS9SgXIWfgP96O6VR-hk
Content-Type: application/x-www-form-urlencoded

Body

data[summary]=Junior+to+mid-level&data[labels][]=Test

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c435fd2f83fe46bd03",
  "type": "Assessment",
  "data": {
    "id": "5e6186c435fd2f83fe46bd03",
    "title": "Junior Big-Data Engineer #139",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c435fd2f83fe46bcfd",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Junior to mid-level",
    "challengeItems": [
      {
        "id": "5e6186c535fd2f83fe46bd0a",
        "challengeId": "5e6186c535fd2f83fe46bd07",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Possimus quia occaecati. Consequatur nisi expedita nobis quia et. Dolores magni et accusamus. Quia esse mollitia neque.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-03-05T23:09:57.036Z",
    "archivedAt": null,
    "createdAt": "2020-03-05T23:09:57.079Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c535fd2f83fe46bd0f",
      "all": 2,
      "started": 2
    },
    "labels": [
      "Test"
    ],
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c535fd2f83fe46bd18",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:57.321-08:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/assessments/:id/publish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5e6186c535fd2f83fe46bd21/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM1MzVmZDJmODNmZTQ2YmQyMiIsImlkIjoiNWU2MTg2YzUzNWZkMmY4M2ZlNDZiZDIzIiwic2VjcmV0IjoiY0V3dFRnPT0ifQ.ZGrjak6eb5EP9zR_kPtMMuk-R_2qDJyAPXKRxv1YQbY
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c535fd2f83fe46bd21",
  "type": "Assessment",
  "data": {
    "id": "5e6186c535fd2f83fe46bd21",
    "title": "Junior Node Developer #140",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c535fd2f83fe46bd1b",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Quam amet hic autem dolores recusandae delectus. Est odit et mollitia quia accusantium. Molestiae labore deserunt aut neque dolorem. Molestiae sapiente similique exercitationem. Consequatur mollitia eveniet expedita nam ut odit.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Quos commodi porro veniam et. Deleniti et et sed. Occaecati ratione accusamus officia corrupti.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-03-05T23:09:57.536Z",
    "archivedAt": null,
    "createdAt": "2020-03-05T23:09:57.503Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c535fd2f83fe46bd26"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c535fd2f83fe46bd25",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:57.576-08:00",
    "includes": []
  }
}

Un-publish

Endpoint

PUT /v1/assessments/:id/unpublish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5e6186c535fd2f83fe46bd3f/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM1MzVmZDJmODNmZTQ2YmQ0MCIsImlkIjoiNWU2MTg2YzUzNWZkMmY4M2ZlNDZiZDQxIiwic2VjcmV0IjoidkhwYmdBPT0ifQ.2UHETUCw8ItI9m52ZaT8nO_OaXLl81J5PPnAtMidRl0
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c535fd2f83fe46bd3f",
  "type": "Assessment",
  "data": {
    "id": "5e6186c535fd2f83fe46bd3f",
    "title": "Mid-Level Node Engineer #142",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c535fd2f83fe46bd39",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Quibusdam veniam et dolorum ut beatae. Et ipsa occaecati sunt at quibusdam. Illo dolore ipsum optio eveniet voluptatem corporis aliquam. Ut sint ea deleniti iste recusandae.",
    "challengeItems": [
      {
        "id": "5e6186c635fd2f83fe46bd46",
        "challengeId": "5e6186c635fd2f83fe46bd43",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Molestiae numquam tempore atque dolor provident. Nisi excepturi non laudantium soluta ex inventore tempora. Doloribus illo pariatur explicabo excepturi eos exercitationem.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-03-05T23:09:58.043Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c635fd2f83fe46bd4b",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c635fd2f83fe46bd54",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:58.280-08:00",
    "includes": []
  }
}

Archive

Archives the assessment

Endpoint

PUT /v1/assessments/:id/archive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5e6186c635fd2f83fe46bd5d/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM2MzVmZDJmODNmZTQ2YmQ1ZSIsImlkIjoiNWU2MTg2YzYzNWZkMmY4M2ZlNDZiZDVmIiwic2VjcmV0IjoiRGpqNnJnPT0ifQ.JULXbEvB6VCkLTYSQlvqTwaDqRY_lD4_5fakZefL6H8
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c635fd2f83fe46bd5d",
  "type": "Assessment",
  "data": {
    "id": "5e6186c635fd2f83fe46bd5d",
    "title": "Mid-Level JavaScript Developer #143",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c635fd2f83fe46bd57",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Similique officiis et delectus nesciunt. Reiciendis commodi voluptas. Perferendis sapiente eos. Tempore distinctio ut dolor. Sapiente alias expedita et consectetur.",
    "challengeItems": [
      {
        "id": "5e6186c635fd2f83fe46bd64",
        "challengeId": "5e6186c635fd2f83fe46bd61",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Eligendi sunt distinctio illum suscipit. A culpa sint illo qui modi. Dolores vel distinctio unde ea illo mollitia officia. Molestias sint eveniet.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-03-05T23:09:58.449Z",
    "archivedAt": "2020-03-05T23:09:58.715Z",
    "createdAt": "2020-03-05T23:09:58.485Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c635fd2f83fe46bd69",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c635fd2f83fe46bd72",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:58.766-08:00",
    "includes": []
  }
}

Unarchive

Unarchives the assessment

Endpoint

PUT /v1/assessments/:id/unarchive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5e6186c735fd2f83fe46bd98/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM2MzVmZDJmODNmZTQ2YmQ3YyIsImlkIjoiNWU2MTg2YzYzNWZkMmY4M2ZlNDZiZDdkIiwic2VjcmV0IjoiNDFNTmlRPT0ifQ.oYXUQV6uPU2hf7TPlEuVnL8TZRmy81h_NzMA5zVif5Y
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c735fd2f83fe46bd98",
  "type": "Assessment",
  "data": {
    "id": "5e6186c735fd2f83fe46bd98",
    "title": "Senior DevOps Engineer #145",
    "state": "draft",
    "teamId": "5e6186c735fd2f83fe46bd92",
    "inviteOnly": false,
    "summary": "",
    "challengeItems": [],
    "unavailable": true
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:09:59.294-08:00",
    "includes": []
  }
}

Recover

Recovers the assessment

Endpoint

PUT /v1/assessments/:id/recover

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5e6186c835fd2f83fe46bdd6/recover

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NmM3MzVmZDJmODNmZTQ2YmRjMiIsImlkIjoiNWU2MTg2YzczNWZkMmY4M2ZlNDZiZGMzIiwic2VjcmV0Ijoid2hidkV3PT0ifQ.0ASf9cjISnSfogoT6C_73X62eSydsWPepCzICPCYJkE
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e6186c835fd2f83fe46bdd6",
  "type": "Assessment",
  "data": {
    "id": "5e6186c835fd2f83fe46bdd6",
    "title": "Junior Big-Data Developer #148",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5e6186c735fd2f83fe46bdbb",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Consequatur et excepturi voluptatum voluptatem eum debitis doloribus. Aut sint eius aperiam beatae aut. Commodi suscipit voluptatem illo. Velit similique sunt enim. Odio deleniti et.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Officiis id et hic cumque impedit. Eveniet dignissimos earum consequuntur. Et provident a recusandae hic. Et corrupti voluptas sit recusandae. Ipsa sit saepe temporibus neque est culpa.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": "2020-03-05T23:10:00.098Z",
    "createdAt": "2020-03-05T23:10:00.104Z",
    "assessmentResultsSummary": {
      "_id": "5e6186c835fd2f83fe46bdd8"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5e6186c835fd2f83fe46bdd7",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:10:00.160-08:00",
    "includes": []
  }
}

Challenge Briefs

Briefs are living report information. They are synced in the background after information related to a challenge is changed. You can consume this data to implement your own reporting tools. Note that all challenge types have been combined into one object, so you will notice fields on each record that may not be relevant to the underlying challenge type.

List

Endpoint

GET /v1/challenge_briefs

Request

Route

GET /v1/challenge_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzI5MzVmZDJmODNmZTQ2YmZlYSIsImlkIjoiNWU2MTg3MjkzNWZkMmY4M2ZlNDZiZmViIiwic2VjcmV0IjoiTnJWYVJ3PT0ifQ.5EBNrckqVOGnxDjr2wODGufch029th3JeiqkTiFf-f8

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "ChallengeBrief",
  "data": [
    {
      "id": "5e61872935fd2f83fe46bfe9",
      "createdAt": "2020-03-05T23:11:37.878Z",
      "updatedAt": "2020-03-05T23:11:37.878Z",
      "teamId": "5e61872935fd2f83fe46bfd3",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-03-05T23:11:38.878Z",
      "syncs": 1,
      "sourcedFromId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5e61872935fd2f83fe46bfdb",
      "challengeId": "5e61872935fd2f83fe46bfdd",
      "challengeCreatedAt": "2020-03-05T23:11:37.568Z",
      "challengeUpdatedAt": "2020-03-05T23:11:37.568Z",
      "publishedAt": "2020-03-05T23:11:37.563Z",
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "published",
      "title": "Insane Process #187",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "passingScore": 100,
      "revisionsCount": 0,
      "copiesCount": 0,
      "assessmentsCount": 1,
      "reviewsCount": 0,
      "assessmentResultsCount": 0,
      "solutionsCount": 1,
      "submittedSolutionsCount": 1,
      "viableSolutionsCount": 0,
      "estimatedTime": 2,
      "timeLimitMin": null,
      "difficulty": 1,
      "languagesCount": 1,
      "topicsCount": null,
      "labelsCount": null,
      "tagsCount": 0,
      "submissionRate": 100.0,
      "viableRate": 0.0,
      "passRate": null,
      "baselineStats": {
        "score": null,
        "accumulated_seconds": null,
        "accumulated_bg_seconds": null,
        "passed_accumulated_seconds": null,
        "passed_accumulated_bg_seconds": null,
        "mass": null,
        "max_similarity": null
      },
      "subjectStats": {
        "score": null,
        "accumulated_seconds": null,
        "accumulated_bg_seconds": null,
        "passed_accumulated_seconds": null,
        "passed_accumulated_bg_seconds": null,
        "mass": null,
        "max_similarity": null
      },
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Logic"
      ],
      "labels": [],
      "languages": [
        {
          "name": "javascript",
          "_id": "5e61872935fd2f83fe46bfdf",
          "total_test_cases": 1,
          "hidden_test_cases": 0,
          "test_framework": "cw-2",
          "generated": null,
          "language_version": "10.x",
          "setup_mass": null,
          "modification_mass": null,
          "mass": null,
          "lines_added": null,
          "lines_removed": null,
          "setup_differential": null,
          "compared_at": null,
          "functions": "",
          "functions_count": 0,
          "identifiers": "",
          "identifiers_count": 0,
          "cluster_count": 0,
          "solutions_stats": {
            "score": null,
            "accumulated_seconds": null,
            "accumulated_bg_seconds": null,
            "wall_time": null,
            "mass": null
          }
        }
      ],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "signalMappingsId": null,
      "customSignalMappings": false,
      "signalMappingsVersion": null,
      "generated": false,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "defaultLanguage": null,
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "importId": null,
      "clustersCount": 0,
      "risks": {
        "total": 0,
        "max": null
      },
      "services": {},
      "exactness": {},
      "testCases": {
        "min": 1,
        "max": 1
      },
      "solutionLanguages": {
        "javascript": 1
      },
      "filesCount": null,
      "refFilesCount": null,
      "enableExternalIde": null,
      "timeLimitType": null,
      "questionTimeLimitSec": null,
      "questionTimeLimitStartSec": null,
      "questionsCount": null,
      "questionTypes": null,
      "questions": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:11:37.957-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenge_briefs/:id

Request

Route

GET /v1/challenge_briefs/5e61872a35fd2f83fe46bff9

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJhMzVmZDJmODNmZTQ2YzAwNiIsImlkIjoiNWU2MTg3MmEzNWZkMmY4M2ZlNDZjMDA3Iiwic2VjcmV0IjoiWjBlWGl3PT0ifQ.VgEmsuCSV_Op5BGiCY00-s6CG5sjemMrBrmS4fDRsRk

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872a35fd2f83fe46c005",
  "type": "ChallengeBrief",
  "data": {
    "id": "5e61872a35fd2f83fe46c005",
    "createdAt": "2020-03-05T23:11:38.573Z",
    "updatedAt": "2020-03-05T23:11:38.573Z",
    "teamId": "5e61872a35fd2f83fe46bfef",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-03-05T23:11:39.573Z",
    "syncs": 1,
    "sourcedFromId": null,
    "templatedFromId": null,
    "copiedFromId": null,
    "createdById": "5e61872a35fd2f83fe46bff7",
    "challengeId": "5e61872a35fd2f83fe46bff9",
    "challengeCreatedAt": "2020-03-05T23:11:38.143Z",
    "challengeUpdatedAt": "2020-03-05T23:11:38.143Z",
    "publishedAt": "2020-03-05T23:11:38.139Z",
    "archivedAt": null,
    "type": "CodeChallenge",
    "state": "published",
    "title": "Email Puzzle #188",
    "summary": null,
    "purpose": null,
    "linkedStatus": "false",
    "copiedFromContentType": null,
    "libraryAccess": null,
    "contentType": "normal",
    "passingScore": 100,
    "revisionsCount": 0,
    "copiesCount": 0,
    "assessmentsCount": 1,
    "reviewsCount": 0,
    "assessmentResultsCount": 0,
    "solutionsCount": 1,
    "submittedSolutionsCount": 1,
    "viableSolutionsCount": 0,
    "estimatedTime": 2,
    "timeLimitMin": null,
    "difficulty": 1,
    "languagesCount": 1,
    "topicsCount": null,
    "labelsCount": null,
    "tagsCount": 0,
    "submissionRate": 100.0,
    "viableRate": 0.0,
    "passRate": null,
    "baselineStats": {
      "score": null,
      "accumulated_seconds": null,
      "accumulated_bg_seconds": null,
      "passed_accumulated_seconds": null,
      "passed_accumulated_bg_seconds": null,
      "mass": null,
      "max_similarity": null
    },
    "subjectStats": {
      "score": null,
      "accumulated_seconds": null,
      "accumulated_bg_seconds": null,
      "passed_accumulated_seconds": null,
      "passed_accumulated_bg_seconds": null,
      "mass": null,
      "max_similarity": null
    },
    "inLibrary": false,
    "copiedFromLibrary": null,
    "titleUniqueFromLibrary": null,
    "recruitment": false,
    "education": true,
    "tags": [],
    "topics": [
      "Algorithms"
    ],
    "labels": [],
    "languages": [
      {
        "name": "javascript",
        "_id": "5e61872a35fd2f83fe46bffb",
        "total_test_cases": 1,
        "hidden_test_cases": 0,
        "test_framework": "cw-2",
        "generated": null,
        "language_version": "10.x",
        "setup_mass": null,
        "modification_mass": null,
        "mass": null,
        "lines_added": null,
        "lines_removed": null,
        "setup_differential": null,
        "compared_at": null,
        "functions": "",
        "functions_count": 0,
        "identifiers": "",
        "identifiers_count": 0,
        "cluster_count": 0,
        "solutions_stats": {
          "score": null,
          "accumulated_seconds": null,
          "accumulated_bg_seconds": null,
          "wall_time": null,
          "mass": null
        }
      }
    ],
    "signalProfilesCount": null,
    "avgSortScore": null,
    "avgKnownScore": null,
    "avgConfidenceScore": null,
    "avgOpinionScore": null,
    "minorOpinionsCount": null,
    "avgKnownObjectivesScore": null,
    "avgKnownQualitiesScore": null,
    "objectivesCount": null,
    "qualitiesCount": null,
    "objectiveCodes": null,
    "qualityCodes": null,
    "signalMappingsId": null,
    "customSignalMappings": false,
    "signalMappingsVersion": null,
    "generated": false,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "defaultLanguage": null,
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "importId": null,
    "clustersCount": 0,
    "risks": {
      "total": 0,
      "max": null
    },
    "services": {},
    "exactness": {},
    "testCases": {
      "min": 1,
      "max": 1
    },
    "solutionLanguages": {
      "javascript": 1
    },
    "filesCount": null,
    "refFilesCount": null,
    "enableExternalIde": null,
    "timeLimitType": null,
    "questionTimeLimitSec": null,
    "questionTimeLimitStartSec": null,
    "questionsCount": null,
    "questionTypes": null,
    "questions": null
  },
  "meta": {
    "timestamp": "2020-03-05T15:11:38.646-08:00",
    "includes": []
  }
}

Challenges

List

Returns all global and team challenges

Endpoint

GET /v1/challenges

Parameters

Name Description
collection if provided will filter by either "team" or "global" challenges
includes Valid values are: team, created_by, solutions
templates If set to true, will return only templates. By default everything but templates are returned
$type The subtype to filter by. Useful as a replacement for using the type specific endpoint

Request

Route

GET /v1/challenges

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJjMzVmZDJmODNmZTQ2YzBkYSIsImlkIjoiNWU2MTg3MmMzNWZkMmY4M2ZlNDZjMGRiIiwic2VjcmV0IjoiT1BOMit3PT0ifQ.0HqOgir7CapAMOdduCs3lrYiD8eAY3JsLQyt61KNSjU

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "CodeChallenge",
  "data": [
    {
      "id": "5e61872c35fd2f83fe46c0d9",
      "$type": "CodeChallenge",
      "teamId": "5e61872c35fd2f83fe46c0d3",
      "createdById": "5e61872c35fd2f83fe46c0db",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Binding Numbers #196",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-03-05T23:11:40.881Z",
      "createdAt": "2020-03-05T23:11:40.886Z",
      "updatedAt": "2020-03-05T23:11:40.886Z",
      "libraryAccess": null,
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5e61872c35fd2f83fe46c0dd",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "team",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "associatedTags": [],
      "signalMappingsId": null,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "yamlConfig": null,
      "languages": [
        {
          "id": "5e61872c35fd2f83fe46c0de",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "Test.expect(a == 1)",
          "preloaded": null,
          "solution": "var a = 1;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    },
    {
      "id": "5e61872c35fd2f83fe46c0e7",
      "$type": "CodeChallenge",
      "teamId": "5e61872c35fd2f83fe46c0e1",
      "createdById": "5e61872c35fd2f83fe46c0e8",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Happy Enumerator #197",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-03-05T23:11:40.984Z",
      "createdAt": "2020-03-05T23:11:40.988Z",
      "updatedAt": "2020-03-05T23:11:40.988Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5e61872c35fd2f83fe46c0eb",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": true,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5e61872c35fd2f83fe46c0ec",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "0ZuS0JTI/UXTLikaqSzmU45MJK3gNHbQYjHJ2btdtqc=\n--7uyQE45rJL8KHQEhKVUZhw==--u"
        }
      ]
    },
    {
      "id": "5e61872d35fd2f83fe46c0f0",
      "$type": "CodeChallenge",
      "teamId": "5e61872c35fd2f83fe46c0e1",
      "createdById": "5e61872c35fd2f83fe46c0e8",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Custom System #199",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Meta-programming"
      ],
      "labels": [
        "Templates"
      ],
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-03-05T23:11:41.016Z",
      "createdAt": "2020-03-05T23:11:41.020Z",
      "updatedAt": "2020-03-05T23:11:41.020Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "template",
      "productTypes": {
        "_id": "5e61872d35fd2f83fe46c0f1",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5e61872d35fd2f83fe46c0f2",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "Test.expect(a == 1)",
          "preloaded": null,
          "solution": "var a = 1;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-03-05T15:11:41.110-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenges/:id

Parameters

Name Description
id base16 ObjectId

Request

Route

GET /v1/challenges/5e61872e35fd2f83fe46c170

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJlMzVmZDJmODNmZTQ2YzE3MSIsImlkIjoiNWU2MTg3MmUzNWZkMmY4M2ZlNDZjMTcyIiwic2VjcmV0IjoiM0dzZnp3PT0ifQ._vd0_0vNo9EbKMxZvoBhJrNEijcH_RKtnFsVULWcYBQ

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872e35fd2f83fe46c170",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61872e35fd2f83fe46c170",
    "$type": "CodeChallenge",
    "teamId": "5e61872e35fd2f83fe46c16a",
    "createdById": "5e61872e35fd2f83fe46c172",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Crazy Calculator #217",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-03-05T23:11:42.434Z",
    "createdAt": "2020-03-05T23:11:42.438Z",
    "updatedAt": "2020-03-05T23:11:42.438Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872e35fd2f83fe46c174",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61872e35fd2f83fe46c175",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:42.491-08:00",
    "includes": []
  }
}

Create (Code Challenge)

Endpoint

POST /v1/challenges

Parameters

Name Description
data.$type required The type of challenge to create
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.state The state of the challenge, can be published, draft or archived
data.enforce_all_tests_on_publish Code Challenge only field: True if all tests should pass on publish, otherwise only a single test must pass. Default is true for new records
data.languages Code Challenge only field: An array of language objects.

Request

Route

POST /v1/challenges

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJlMzVmZDJmODNmZTQ2YzE3ZiIsImlkIjoiNWU2MTg3MmUzNWZkMmY4M2ZlNDZjMTgwIiwic2VjcmV0Ijoiek80a2JBPT0ifQ.IBO_00_AYWN8ltFwjUBBxc-3U72I5JpFwhGbFjKF0mI

Body

{
  "data": {
    "$type": "CodeChallenge",
    "title": "test challenge",
    "purpose": "abc",
    "enforceAllTestsOnPublish": false,
    "state": "published",
    "instructions": "Do some work",
    "languages": [
      {
        "name": "javascript",
        "solution": "var a = 2",
        "test_cases": "Test.assertEquals(a,2)"
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872e35fd2f83fe46c184",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61872e35fd2f83fe46c184",
    "$type": "CodeChallenge",
    "teamId": "5e61872e35fd2f83fe46c178",
    "createdById": "5e61872e35fd2f83fe46c180",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "test challenge",
    "instructions": "Do some work",
    "difficulty": null,
    "summary": null,
    "purpose": "abc",
    "topics": null,
    "labels": null,
    "estimatedTime": null,
    "state": "published",
    "publishedAt": "2020-03-05T23:11:42.719Z",
    "createdAt": "2020-03-05T23:11:42.723Z",
    "updatedAt": "2020-03-05T23:11:42.723Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872e35fd2f83fe46c17b",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": false,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61872e35fd2f83fe46c185",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 0,
        "hiddenTestCases": 0,
        "exampleTestCases": null,
        "setup": null,
        "testCases": "Test.assertEquals(a,2)",
        "preloaded": null,
        "solution": "var a = 2",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:42.746-08:00",
    "includes": []
  }
}

Create (Quiz Challenge)

Endpoint

POST /v1/challenges

Parameters

Name Description
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.state The state of the challenge, can be published, draft or archived

Request

Route

POST /v1/challenges

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJlMzVmZDJmODNmZTQ2YzE5MCIsImlkIjoiNWU2MTg3MmUzNWZkMmY4M2ZlNDZjMTkxIiwic2VjcmV0Ijoid1RCMzJ3PT0ifQ.OAvwpvYqw2RqnAqpV84OeZgDUBkcJ1jrkPQ16w2wucA

Body

{
  "data": {
    "$type": "QuizChallenge",
    "title": "test challenge",
    "purpose": "abc",
    "state": "draft",
    "instructions": "Do some work"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872e35fd2f83fe46c19c",
  "type": "QuizChallenge",
  "data": {
    "id": "5e61872e35fd2f83fe46c19c",
    "$type": "QuizChallenge",
    "teamId": "5e61872e35fd2f83fe46c189",
    "createdById": "5e61872e35fd2f83fe46c191",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "test challenge",
    "instructions": "Do some work",
    "difficulty": null,
    "summary": null,
    "purpose": "abc",
    "topics": null,
    "labels": null,
    "estimatedTime": null,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-03-05T23:11:42.976Z",
    "updatedAt": "2020-03-05T23:11:42.976Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872e35fd2f83fe46c18c",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "timeLimitType": "none",
    "questionTimeLimitSec": null,
    "questionTimeLimitStartSec": null,
    "questions": []
  },
  "meta": {
    "enums": {
      "timeLimitType": [
        {
          "value": "none",
          "text": "No Time Limit"
        },
        {
          "value": "challenge",
          "text": "Challenge Time Limit"
        },
        {
          "value": "per_question",
          "text": "Per Question Time Limit"
        },
        {
          "value": "per_question_bonus",
          "text": "Per Question Time Limit with Time Bonus"
        }
      ],
      "questions": {
        "language": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:42.997-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/challenges/:id

Parameters

Name Description
id required base16 ObjectId
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.languages CodeChallenge only field: An array of language objects. Provide a removed: true value if you wish to remove an existing challenge language

Request

Route

PUT /v1/challenges/5e61872f35fd2f83fe46c1a6

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJmMzVmZDJmODNmZTQ2YzFhNyIsImlkIjoiNWU2MTg3MmYzNWZkMmY4M2ZlNDZjMWE4Iiwic2VjcmV0Ijoib0xtWCtRPT0ifQ._jyG34ufw65xtNqrNsrfL1VGHqYt1HenOguLGNHZRGA

Body

{
  "data": {
    "$type": "CodeChallenge",
    "languages": [
      {
        "name": "ruby",
        "solution": "a = 1"
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872f35fd2f83fe46c1a6",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61872f35fd2f83fe46c1a6",
    "$type": "CodeChallenge",
    "teamId": "5e61872f35fd2f83fe46c1a0",
    "createdById": "5e61872f35fd2f83fe46c1a8",
    "lastUpdatedById": "5e61872f35fd2f83fe46c1a8",
    "copiedFromId": null,
    "title": "Sequential Game #220",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-03-05T23:11:43.196Z",
    "updatedAt": "2020-03-05T23:11:43.263Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872f35fd2f83fe46c1aa",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61872f35fd2f83fe46c1ac",
        "name": "ruby",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "2.5.x",
        "languageVersionName": "MRI 2.5.1",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "rspec"
        ],
        "totalTestCases": 0,
        "hiddenTestCases": 0,
        "exampleTestCases": null,
        "setup": null,
        "testCases": null,
        "preloaded": null,
        "solution": "a = 1",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:43.285-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/challenges/:id

Request

Route

DELETE /v1/challenges/5e61872f35fd2f83fe46c1b5

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJmMzVmZDJmODNmZTQ2YzFiNiIsImlkIjoiNWU2MTg3MmYzNWZkMmY4M2ZlNDZjMWI3Iiwic2VjcmV0Ijoib041VzhBPT0ifQ.2ai7CBt51B8RE3m_CbtFswSAjVdy873z9VlBEXmZOaY
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Un-Publish

Endpoint

PUT /v1/challenges/:id/unpublish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5e61872f35fd2f83fe46c1c3/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJmMzVmZDJmODNmZTQ2YzFjNCIsImlkIjoiNWU2MTg3MmYzNWZkMmY4M2ZlNDZjMWM1Iiwic2VjcmV0IjoiRGJ0MUJnPT0ifQ.YK09R4oOccKjRPWqbOPvKnPLKmMhFS0O1sw2dUSffZA
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872f35fd2f83fe46c1c3",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61872f35fd2f83fe46c1c3",
    "$type": "CodeChallenge",
    "teamId": "5e61872f35fd2f83fe46c1bd",
    "createdById": "5e61872f35fd2f83fe46c1c5",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Cipher Parser #222",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-03-05T23:11:43.673Z",
    "updatedAt": "2020-03-05T23:11:43.719Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872f35fd2f83fe46c1c7",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61872f35fd2f83fe46c1c8",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:43.744-08:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/challenges/:id/publish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5e61872f35fd2f83fe46c1d1/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzJmMzVmZDJmODNmZTQ2YzFkMiIsImlkIjoiNWU2MTg3MmYzNWZkMmY4M2ZlNDZjMWQzIiwic2VjcmV0Ijoic1pFTi9RPT0ifQ.is9SWBrer1tFPfcUcdhZ5P8AL7rDRckTCAgAzGy6-DQ
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61872f35fd2f83fe46c1d1",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61872f35fd2f83fe46c1d1",
    "$type": "CodeChallenge",
    "teamId": "5e61872f35fd2f83fe46c1cb",
    "createdById": "5e61872f35fd2f83fe46c1d3",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Polymorphic Lists #223",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-03-05T23:11:43.935Z",
    "createdAt": "2020-03-05T23:11:43.900Z",
    "updatedAt": "2020-03-05T23:11:43.942Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61872f35fd2f83fe46c1d5",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61872f35fd2f83fe46c1d6",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:43.965-08:00",
    "includes": []
  }
}

Archive

Endpoint

PUT /v1/challenges/:id/archive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5e61873035fd2f83fe46c1df/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzMwMzVmZDJmODNmZTQ2YzFlMCIsImlkIjoiNWU2MTg3MzAzNWZkMmY4M2ZlNDZjMWUxIiwic2VjcmV0IjoiZ0lRMVdRPT0ifQ.F2yB79SY4GJUDcunuP4EjaL1iMgkV4CDsPdQApXthc8
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61873035fd2f83fe46c1df",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61873035fd2f83fe46c1df",
    "$type": "CodeChallenge",
    "teamId": "5e61873035fd2f83fe46c1d9",
    "createdById": "5e61873035fd2f83fe46c1e1",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Balanced Problem #224",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "archived",
    "publishedAt": "2020-03-05T23:11:44.116Z",
    "createdAt": "2020-03-05T23:11:44.121Z",
    "updatedAt": "2020-03-05T23:11:44.165Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61873035fd2f83fe46c1e3",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61873035fd2f83fe46c1e4",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:44.186-08:00",
    "includes": []
  }
}

Un-archive

Endpoint

PUT /v1/challenges/:id/unarchive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5e61873035fd2f83fe46c1fd/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzMwMzVmZDJmODNmZTQ2YzFmZSIsImlkIjoiNWU2MTg3MzAzNWZkMmY4M2ZlNDZjMWZmIiwic2VjcmV0IjoiNVMzS2ZRPT0ifQ.KK8YzhAXSVzsCVC-kTAPeoQLbTuiCTVtfyefebrGbHw
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61873035fd2f83fe46c1fd",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61873035fd2f83fe46c1fd",
    "$type": "CodeChallenge",
    "teamId": "5e61873035fd2f83fe46c1f7",
    "createdById": "5e61873035fd2f83fe46c1ff",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Inverted Methods #226",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-03-05T23:11:44.620Z",
    "createdAt": "2020-03-05T23:11:44.584Z",
    "updatedAt": "2020-03-05T23:11:44.627Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61873035fd2f83fe46c201",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61873035fd2f83fe46c202",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:44.651-08:00",
    "includes": []
  }
}

Import

Imports a challenge into the team library. Can also be used to copy challenges

Endpoint

POST /v1/challenges/:id/import

Parameters

Name Description
id required base16 ObjectId

Request

Route

POST /v1/challenges/5e61873235fd2f83fe46c290/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzMyMzVmZDJmODNmZTQ2YzI5MSIsImlkIjoiNWU2MTg3MzIzNWZkMmY4M2ZlNDZjMjkyIiwic2VjcmV0IjoiRWZJNExRPT0ifQ.HVNaF2nmVVoW6hfhTX2iUGWcS5P-jhZ_bBGP9Ak3I6k
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61873235fd2f83fe46c297",
  "type": "CodeChallenge",
  "data": {
    "id": "5e61873235fd2f83fe46c297",
    "$type": "CodeChallenge",
    "teamId": "5e61873235fd2f83fe46c28a",
    "createdById": "5e61873235fd2f83fe46c292",
    "lastUpdatedById": null,
    "copiedFromId": "5e61873235fd2f83fe46c290",
    "title": "Insane Problem #230 (2020-03-05)",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-03-05T23:11:46.215Z",
    "createdAt": "2020-03-05T23:11:46.164Z",
    "updatedAt": "2020-03-05T23:11:46.164Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": false,
    "copiedFromContentType": "normal",
    "contentType": "normal",
    "productTypes": {
      "_id": "5e61873235fd2f83fe46c29a",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": true,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5e61873235fd2f83fe46c299",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var a = 1;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-03-05T15:11:46.260-08:00",
    "includes": []
  }
}

Label History

List

Endpoint

GET /v1/label_histories

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/label_histories?team_id=5e61874a35fd2f83fe46c580

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRhMzVmZDJmODNmZTQ2YzU4NyIsImlkIjoiNWU2MTg3NGEzNWZkMmY4M2ZlNDZjNTg4Iiwic2VjcmV0IjoiR1A3SFFnPT0ifQ.bFN6DNK5ziFgjWLLMxugy18PjvHrfvI5X1Ye--PrLxQ

Query Parameters

team_id=5e61874a35fd2f83fe46c580

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "LabelHistory",
  "data": [
    {
      "id": "5e61874a35fd2f83fe46c586",
      "name": "Test",
      "addedAt": "2020-03-05T23:12:10.603Z",
      "removedAt": null,
      "teamId": "5e61874a35fd2f83fe46c580",
      "labeledId": "5e61874a35fd2f83fe46c57d",
      "labeledType": "TeamCandidate",
      "addedById": null,
      "removedById": null,
      "labeled": {
        "id": "5e61874a35fd2f83fe46c57d",
        "candidateId": "5e61874a35fd2f83fe46c57c",
        "teamId": "5e61874a35fd2f83fe46c580",
        "state": "invited",
        "demoData": false,
        "prevState": null,
        "assessmentIds": [],
        "assessmentResultIds": [],
        "blinding": "blind_reviewers",
        "createdAt": "2020-03-05T23:12:10.573Z",
        "updatedAt": "2020-03-05T23:12:10.573Z",
        "decidedAt": null,
        "invitedAt": "2020-03-05T23:12:10.573Z",
        "interactSessions": 0,
        "stateUpdatedAt": "2020-03-05T23:12:10.573Z",
        "testTeamMember": false,
        "assignedTeamMemberIds": [],
        "labels": null,
        "archived": false,
        "firstName": "Joe",
        "lastName": "Smith477",
        "anonymousName": "Gold Panther",
        "email": "[email protected]",
        "name": "Joe Smith477",
        "isBlinded": false,
        "stateLabel": "Invited",
        "angelId": null,
        "stateTransitions": [
          "idle",
          "invited",
          "started",
          "submitted",
          "risk_detected",
          "reviewed",
          "approved",
          "rejected",
          "archived"
        ],
        "risks": null,
        "assessmentsRecap": {
          "id": "5e61874a35fd2f83fe46c58a",
          "subjects": []
        }
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:10.713-08:00",
    "includes": []
  }
}

Notes

List

Endpoint

GET /v1/notes

Parameters

Name Description
includes Valid values are:
notable_id required id of the parent the note belongs to

Request

Route

GET /v1/notes?notable_id=5e61874a35fd2f83fe46c598

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRhMzVmZDJmODNmZTQ2YzU4YiIsImlkIjoiNWU2MTg3NGEzNWZkMmY4M2ZlNDZjNThjIiwic2VjcmV0IjoiNXB0eWtBPT0ifQ.JzmXOco6ZZzIzWc34mY9Fpfuw8r-i854UKX5Ux3-7Xk

Query Parameters

notable_id=5e61874a35fd2f83fe46c598

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Note",
  "data": [
    {
      "id": "5e61874b35fd2f83fe46c5a5",
      "body": "Voluptatum corrupti quis deserunt sequi illo fuga.",
      "userId": "5e61874b35fd2f83fe46c59d",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5e61874a35fd2f83fe46c598"
    },
    {
      "id": "5e61874b35fd2f83fe46c5a6",
      "body": "Et minus omnis occaecati libero fugit itaque voluptatem aspernatur.",
      "userId": "5e61874b35fd2f83fe46c5a3",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5e61874a35fd2f83fe46c598"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2020-03-05T15:12:11.112-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/notes/:id

Parameters

Name Description
notable_id id of the parent the note belongs to

Request

Route

GET /v1/notes/5e61874b35fd2f83fe46c5e1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRiMzVmZDJmODNmZTQ2YzVjNyIsImlkIjoiNWU2MTg3NGIzNWZkMmY4M2ZlNDZjNWM4Iiwic2VjcmV0IjoiWnJtYml3PT0ifQ.T9GUhusD4le4QMyYPbi75SseabK3eVm_DLV68pJSd6A

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61874b35fd2f83fe46c5e1",
  "type": "Note",
  "data": {
    "id": "5e61874b35fd2f83fe46c5e1",
    "body": "Ad officiis assumenda est rem praesentium ut.",
    "userId": "5e61874b35fd2f83fe46c5d9",
    "createdAt": null,
    "updatedAt": null,
    "notableId": "5e61874b35fd2f83fe46c5d4"
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:11.908-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/notes

Parameters

Name Description
data.body required data.body
data.notable_id required id of the parent the note belongs to
data.notable_type type of the parent. Defaults to TeamCandidate

Request

Route

POST /v1/notes

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRiMzVmZDJmODNmZTQ2YzVlMyIsImlkIjoiNWU2MTg3NGIzNWZkMmY4M2ZlNDZjNWU0Iiwic2VjcmV0IjoiNEZFU0VRPT0ifQ.p-YWI_ngjrhxgDUF1Cer9FYO_zqWmwDDMag_5KmxaC8

Body

{
  "data": {
    "body": "body",
    "notable_id": "5e61874c35fd2f83fe46c5f0",
    "notable_type": "TeamCandidate"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61874c35fd2f83fe46c5ff",
  "type": "Note",
  "data": {
    "id": "5e61874c35fd2f83fe46c5ff",
    "body": "body",
    "userId": "5e61874b35fd2f83fe46c5e4",
    "createdAt": "2020-03-05T23:12:12.317Z",
    "updatedAt": "2020-03-05T23:12:12.317Z",
    "notableId": "5e61874c35fd2f83fe46c5f0"
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:12.321-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/notes/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/notes/5e61874d35fd2f83fe46c658

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRkMzVmZDJmODNmZTQ2YzYzZSIsImlkIjoiNWU2MTg3NGQzNWZkMmY4M2ZlNDZjNjNmIiwic2VjcmV0IjoieUtaRm13PT0ifQ.gczJ0uAfLmtmRSskblhx_F0WCBINxvM49OXdwA9IS98

Body

{
  "data": {
    "body": "foo"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61874d35fd2f83fe46c658",
  "type": "Note",
  "data": {
    "id": "5e61874d35fd2f83fe46c658",
    "body": "foo",
    "userId": "5e61874d35fd2f83fe46c650",
    "createdAt": null,
    "updatedAt": "2020-03-05T23:12:13.539Z",
    "notableId": "5e61874d35fd2f83fe46c64b"
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:13.545-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/notes/:id

Request

Route

DELETE /v1/notes/5e61874d35fd2f83fe46c674

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzRkMzVmZDJmODNmZTQ2YzY1YSIsImlkIjoiNWU2MTg3NGQzNWZkMmY4M2ZlNDZjNjViIiwic2VjcmV0IjoieXRxb3pRPT0ifQ.bTf0pqwYcSK_EgHh0OK5K2LCKizFhECkeKcBGxVowoU
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Quiz Questions

List

This endpoint will return a list of questions for a particular quiz challenge.

Endpoint

GET /v1/quiz_questions

Parameters

Name Description
includes Valid values are: revisions

Request

Route

GET /v1/quiz_questions?challenge_id=5e61875135fd2f83fe46c76f

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzUxMzVmZDJmODNmZTQ2Yzc3MCIsImlkIjoiNWU2MTg3NTEzNWZkMmY4M2ZlNDZjNzcxIiwic2VjcmV0IjoiN05ydmtnPT0ifQ.d7ud1rSPV7FwjI4wM25YRMhefSBSMkOifxRvSotmnq4

Query Parameters

challenge_id=5e61875135fd2f83fe46c76f

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "QuizMultipleChoiceQuestion",
  "data": [
    {
      "id": "5e61875135fd2f83fe46c774",
      "$type": "QuizMultipleChoiceQuestion",
      "prompt": "Eum totam assumenda nulla. Optio nam cum. Natus ea commodi vel nisi. Accusamus quam animi sed ut. Est neque tempore.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "choices": [
        "True",
        "False"
      ],
      "maxSelections": null,
      "answers": [
        0
      ]
    },
    {
      "id": "5e61875135fd2f83fe46c775",
      "$type": "QuizTextQuestion",
      "prompt": "Vel possimus voluptatum illum. Ea ut eum cumque magni adipisci. Ducimus nemo dolorem ab non ipsam repellendus repudiandae.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "minCharacters": 5,
      "maxCharacters": 200,
      "defaultValue": "",
      "matchers": null
    },
    {
      "id": "5e61875135fd2f83fe46c776",
      "$type": "QuizWeightedChoiceQuestion",
      "prompt": "Earum natus sequi voluptatem voluptatem quo voluptates numquam. Vel dolorum reprehenderit earum sequi. Nemo ratione alias iste qui pariatur. Mollitia blanditiis magnam. Culpa et rerum consectetur quam et harum ut.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {
        "automax": true
      },
      "weight": 1.0,
      "unitTags": [],
      "maxSelections": 5,
      "maxSum": 5.0,
      "weightedScoring": true,
      "choices": [
        {
          "label": "Ruby",
          "value": 1.0,
          "unitTags": []
        },
        {
          "label": "Python",
          "value": 0.0,
          "unitTags": []
        },
        {
          "label": "Php",
          "value": -1.0,
          "unitTags": []
        },
        {
          "label": "JavaScript",
          "value": 2.0,
          "unitTags": []
        },
        {
          "label": "TypeScript",
          "value": 2.0,
          "unitTags": []
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-03-05T15:12:18.132-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/quiz_questions/:id

Parameters

Name Description
id base16 ObjectId
challenge_id base16 ObjectId: optional but recommended for faster question lookup

Request

Route

GET /v1/quiz_questions/5e61875235fd2f83fe46c79e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzUyMzVmZDJmODNmZTQ2Yzc5YSIsImlkIjoiNWU2MTg3NTIzNWZkMmY4M2ZlNDZjNzliIiwic2VjcmV0IjoiTTlaVlhnPT0ifQ.wzTT9V2hbSRhbTCRrCrVNVsm7Qaahh8T74wkC9PahWM

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61875235fd2f83fe46c79e",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5e61875235fd2f83fe46c79e",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "Qui optio illum numquam qui quos eos. Iste fugiat perferendis. Maiores nulla ut voluptatem nam eaque quos.",
    "position": null,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": null,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:18.345-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/quiz_questions

Parameters

Name Description
data.prompt required data.prompt
data.$type required The type of class that should be created. Can also use "type" or "_type" as param name.
data.challenge_id required the ID of the challenge to add the question to
data.position The 1 based position of the challenge within the list. Will be auto-set to the end of the list if omitted.
data.options data.options
data.weight data.weight
data.all_or_nothing data.all or nothing
data.language A language tag for this question.
data.answers A QuizMulitipleChoiceQuestion only field
data.choices A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_selections A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_sum A QuizWeightedChoiceQuestion only field
data.sorted A QuizMultipleChoiceQuestion/ only field
data.matchers A QuizTextQuestion only field
data.min_characters A QuizTextQuestion only field
data.max_characters A QuizTextQuestion only field

Request

Route

POST /v1/quiz_questions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzUyMzVmZDJmODNmZTQ2YzdhZiIsImlkIjoiNWU2MTg3NTIzNWZkMmY4M2ZlNDZjN2IwIiwic2VjcmV0IjoiRUtWZ2J3PT0ifQ.I7CQjjovNEe4qZQL8lmFtIOqc6vmRnwRp_P8_7pNs3Q

Body

{
  "data": {
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "challenge_id": "5e61875235fd2f83fe46c7ae",
    "choices": [
      "True",
      "False"
    ],
    "answers": [
      1
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61875235fd2f83fe46c7bb",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5e61875235fd2f83fe46c7bb",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "position": 4,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": 1,
    "answers": [
      1
    ]
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:18.577-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/quiz_questions/:id

Parameters

Name Description
id required base16 ObjectId
data.prompt required data.prompt
data.position data.position
data.options data.options
data.weight data.weight
data.all_or_nothing data.all or nothing
data.answers A QuizMultipleChoiceQuestion only field
data.choices A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_selections A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_sum A QuizWeightedChoiceQuestion only field
data.sorted A QuizMultipleChoiceQuestion only field
data.matchers A QuizTextQuestion only field
data.min_characters A QuizTextQuestion only field
data.max_characters A QuizTextQuestion only field

Request

Route

PUT /v1/quiz_questions/5e61875235fd2f83fe46c7c9

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzUyMzVmZDJmODNmZTQ2YzdjNSIsImlkIjoiNWU2MTg3NTIzNWZkMmY4M2ZlNDZjN2M2Iiwic2VjcmV0IjoiSmRLby9BPT0ifQ.GxpkYldTDXaZAmY_C11aZeuhrbbpuZuQeATiMg5qrOo

Body

{
  "data": {
    "prompt": "abcd",
    "choices": [
      {
        "label": "Red",
        "value": 0
      },
      {
        "label": "Yellow",
        "value": 1
      },
      {
        "label": "Green",
        "value": 1
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61875235fd2f83fe46c7c9",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5e61875235fd2f83fe46c7c9",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "abcd",
    "position": 3,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "Red",
      "Yellow",
      "Green"
    ],
    "maxSelections": 1,
    "answers": [
      1,
      2
    ]
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:18.884-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/quiz_questions/:id

Request

Route

DELETE /v1/quiz_questions/5e61875335fd2f83fe46c7e0

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzUzMzVmZDJmODNmZTQ2YzdkYyIsImlkIjoiNWU2MTg3NTMzNWZkMmY4M2ZlNDZjN2RkIiwic2VjcmV0IjoiVkEwWTVnPT0ifQ.Gkj32CaZex1CjYKQ0ppYA2EOGjNjKIn2oubGbU4wd2Q
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Solution Briefs

Briefs are living report information. They are synced in the background after information related to a solution is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/solution_briefs

Request

Route

GET /v1/solution_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzYxMzVmZDJmODNmZTQ2Y2E3OCIsImlkIjoiNWU2MTg3NjEzNWZkMmY4M2ZlNDZjYTc5Iiwic2VjcmV0Ijoid1kvTjZBPT0ifQ.cu9ODGi3BhKkBjy8WUjY4g274FN5IK2CeBi-EeHyvNg

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "SolutionBrief",
  "data": [
    {
      "id": "5e61876135fd2f83fe46ca75",
      "createdAt": "2020-03-05T23:12:33.607Z",
      "updatedAt": "2020-03-05T23:12:33.672Z",
      "teamId": "5e61876135fd2f83fe46ca57",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-03-05T23:12:34.657Z",
      "syncs": 1,
      "candidateId": "5e61876135fd2f83fe46ca5f",
      "teamCandidateId": "5e61876135fd2f83fe46ca60",
      "assessmentResultId": "5e61876135fd2f83fe46ca71",
      "challengeId": "5e61876135fd2f83fe46ca6d",
      "sourcedFromId": null,
      "copiedFromId": null,
      "assessmentId": "5e61876135fd2f83fe46ca69",
      "solutionId": "5e61876135fd2f83fe46ca5d",
      "solutionCreatedAt": "2020-03-05T23:11:33.314Z",
      "solutionUpdatedAt": "2020-03-05T23:12:33.578Z",
      "score": 0.0,
      "accumulatedSeconds": 0,
      "accumulatedBgSeconds": 0,
      "candidateNotes": null,
      "reviewRatings": {},
      "type": "CodeSolution",
      "revisions": 0,
      "revisionTags": {},
      "reviewsCount": 0,
      "submittedIn": null,
      "submittedAt": null,
      "viable": false,
      "passingScore": false,
      "sortScore": 0.25,
      "selectionScore": 0.25,
      "knownScore": 0.0,
      "confidenceScore": 1.0,
      "opinionScore": null,
      "knownObjectivesScore": 0.0,
      "knownQualitiesScore": null,
      "signalBandsCount": 1,
      "signalRatingsCount": 0,
      "signalBands": {
        "signals_score": {
          "REQS": 0.0
        },
        "strength": {
          "REQS": 1
        },
        "strength_score": {
          "REQS": 1.0
        },
        "tag_score": {
          "REQS": 0.0
        }
      },
      "attempts": 1,
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "wallTime": 40,
      "testAttempts": 0,
      "totalTestCases": 1,
      "hiddenTestCases": 0,
      "solutionLength": 10,
      "firstTestCaseSolvedAt": "2020-03-05T23:12:33.315Z",
      "completedAt": "2020-03-05T23:12:33.315Z",
      "completedIn": null,
      "language": "javascript",
      "similarity": null,
      "fileCount": null,
      "reopenedCount": null,
      "foreignTestCasesCount": null,
      "usedExternalIde": null,
      "completion": null,
      "answers": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:33.746-08:00",
    "includes": []
  }
}

Solution Reviews

List

Endpoint

GET /v1/solution_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/solution_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzYyMzVmZDJmODNmZTQ2Y2FjMSIsImlkIjoiNWU2MTg3NjMzNWZkMmY4M2ZlNDZjYWMyIiwic2VjcmV0IjoiL0hVeStBPT0ifQ.Sxj3QJa4jiplFaa0oUEnC1Ws5MYYhuWmntQDXqQQXmQ

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "SolutionReview",
  "data": [
    {
      "id": "5e61876335fd2f83fe46cac4",
      "reviewedById": "5e61876335fd2f83fe46cac2",
      "reviewedByStaff": null,
      "assessmentId": "5e61876235fd2f83fe46cab5",
      "assessmentResultId": "5e61876235fd2f83fe46cabd",
      "teamCandidateId": "5e61876235fd2f83fe46caac",
      "candidateId": "5e61876235fd2f83fe46caab",
      "challengeId": "5e61876235fd2f83fe46cab9",
      "solutionId": "5e61876235fd2f83fe46caa9",
      "rating": 3,
      "feedback": null,
      "assessmentResultReviewId": "5e61876335fd2f83fe46cac5",
      "avgQualitySignalScore": null,
      "positiveQualityIds": [],
      "negativeQualityIds": [],
      "qualities": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:35.207-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solution_reviews/:id

Request

Route

GET /v1/solution_reviews/5e61876335fd2f83fe46caec

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzYzMzVmZDJmODNmZTQ2Y2FlOSIsImlkIjoiNWU2MTg3NjMzNWZkMmY4M2ZlNDZjYWVhIiwic2VjcmV0IjoidlRhV2dnPT0ifQ.fob6ESsOWeSwqDNQE5qs6rYKuREqXd4chxk7h0fQo7Q

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876335fd2f83fe46caec",
  "type": "SolutionReview",
  "data": {
    "id": "5e61876335fd2f83fe46caec",
    "reviewedById": "5e61876335fd2f83fe46caea",
    "reviewedByStaff": null,
    "assessmentId": "5e61876335fd2f83fe46cadd",
    "assessmentResultId": "5e61876335fd2f83fe46cae5",
    "teamCandidateId": "5e61876335fd2f83fe46cad4",
    "candidateId": "5e61876335fd2f83fe46cad3",
    "challengeId": "5e61876335fd2f83fe46cae1",
    "solutionId": "5e61876335fd2f83fe46cad1",
    "rating": 3,
    "feedback": null,
    "assessmentResultReviewId": "5e61876335fd2f83fe46caed",
    "avgQualitySignalScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:35.908-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/solution_reviews

Parameters

Name Description
data.assessment_result_review_id required data.assessment result review
data.solution_id required data.solution
data.feedback data.feedback

Request

Route

POST /v1/solution_reviews

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzY0MzVmZDJmODNmZTQ2Y2IxMSIsImlkIjoiNWU2MTg3NjQzNWZkMmY4M2ZlNDZjYjEyIiwic2VjcmV0IjoicndEUVFBPT0ifQ.z4a9XRFj8rhVcptcnAhyZPOOjGelACwzLY-tyrPhXqE

Body

{
  "data": {
    "feedback": "",
    "solution_id": "5e61876435fd2f83fe46caf9",
    "assessment_result_review_id": "5e61876435fd2f83fe46cb14"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876435fd2f83fe46cb15",
  "type": "SolutionReview",
  "data": {
    "id": "5e61876435fd2f83fe46cb15",
    "reviewedById": "5e61876435fd2f83fe46cb12",
    "reviewedByStaff": false,
    "assessmentId": "5e61876435fd2f83fe46cb05",
    "assessmentResultId": "5e61876435fd2f83fe46cb0d",
    "teamCandidateId": "5e61876435fd2f83fe46cafc",
    "candidateId": "5e61876435fd2f83fe46cafb",
    "challengeId": "5e61876435fd2f83fe46cb09",
    "solutionId": "5e61876435fd2f83fe46caf9",
    "rating": null,
    "feedback": "",
    "assessmentResultReviewId": "5e61876435fd2f83fe46cb14",
    "avgQualitySignalScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:36.575-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/solution_reviews/:id

Parameters

Name Description
data.feedback required data.feedback

Request

Route

PUT /v1/solution_reviews/5e61876535fd2f83fe46cb39

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzY1MzVmZDJmODNmZTQ2Y2IzNiIsImlkIjoiNWU2MTg3NjUzNWZkMmY4M2ZlNDZjYjM3Iiwic2VjcmV0IjoiSmhnR2h3PT0ifQ.0dFQEoNSISACz6KpppSSJToMvouZxLXZPQXHm3o_SBM

Body

{
  "data": {
    "feedback": "feedback"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876535fd2f83fe46cb39",
  "type": "SolutionReview",
  "data": {
    "id": "5e61876535fd2f83fe46cb39",
    "reviewedById": "5e61876535fd2f83fe46cb37",
    "reviewedByStaff": false,
    "assessmentId": "5e61876435fd2f83fe46cb2a",
    "assessmentResultId": "5e61876535fd2f83fe46cb32",
    "teamCandidateId": "5e61876435fd2f83fe46cb21",
    "candidateId": "5e61876435fd2f83fe46cb20",
    "challengeId": "5e61876435fd2f83fe46cb2e",
    "solutionId": "5e61876435fd2f83fe46cb1e",
    "rating": 3,
    "feedback": "feedback",
    "assessmentResultReviewId": "5e61876535fd2f83fe46cb3a",
    "avgQualitySignalScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:37.447-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/solution_reviews/:id

Request

Route

DELETE /v1/solution_reviews/5e61876635fd2f83fe46cb61

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzY2MzVmZDJmODNmZTQ2Y2I1ZSIsImlkIjoiNWU2MTg3NjYzNWZkMmY4M2ZlNDZjYjVmIiwic2VjcmV0IjoibFpnVW5BPT0ifQ.ZSrtq8o4zlF8qqyBRuLC3_JHDxtuAkziWv3TZCqdB80
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Solutions

List

Endpoint

GET /v1/solutions

Parameters

Name Description
includes Valid values are: candidate, challenge, assessment_result, cloned_from, clones
challenge_id Also available via /challenges/:challenge_id/solutions
assessment_result_id Also available via /assessment_results/:assessment_result_id/solutions

Request

Route

GET /v1/solutions?data[team_candidate_id]=5e61876635fd2f83fe46cb94

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzY3MzVmZDJmODNmZTQ2Y2JhMSIsImlkIjoiNWU2MTg3NjczNWZkMmY4M2ZlNDZjYmEyIiwic2VjcmV0IjoiajZlS253PT0ifQ.bnZ11GnnVeMaCrGd-Yg9fCOCpW2f-DDjEANKZFHdihM

Query Parameters

data={"team_candidate_id"=>"5e61876635fd2f83fe46cb94"}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "CodeSolution",
  "data": [
    {
      "id": "5e61876635fd2f83fe46cb99",
      "$type": "CodeSolution",
      "estimatedTime": null,
      "createdAt": "2020-03-05T23:11:38.975Z",
      "challengeId": "5e61876635fd2f83fe46cb9a",
      "assessmentResultId": "5e61876635fd2f83fe46cb95",
      "assessmentId": "5e61876635fd2f83fe46cb8e",
      "candidateId": "5e61876635fd2f83fe46cb93",
      "teamCandidateId": "5e61876635fd2f83fe46cb94",
      "teamId": "5e61876635fd2f83fe46cb88",
      "clonedFromId": null,
      "lastHeartbeat": null,
      "accumulatedSeconds": 0,
      "candidateNotes": null,
      "language": "javascript",
      "firstTestCaseSolvedAt": "2020-03-05T23:12:38.976Z",
      "completedAt": "2020-03-05T23:12:38.976Z",
      "code": "var a = 1;",
      "testCases": "Test.assertEquals(a, 1)",
      "testFramework": "cw-2",
      "attempts": 1,
      "output": [
        {
          "t": "passed",
          "v": "Test Passed"
        }
      ],
      "wallTime": 40,
      "firstTestCompletedIn": 60.001,
      "completedIn": 60.001,
      "specs": null,
      "assertions": null,
      "response": null,
      "testResponse": null,
      "successMode": "specs",
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "totalTestCases": 1,
      "hiddenTestCases": 0,
      "sampleTestCasesEnabled": true,
      "cursor": {},
      "revisionCount": 0,
      "score": 0.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:39.147-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id

Request

Route

GET /v1/solutions/5e61876a35fd2f83fe46cc6a

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZhMzVmZDJmODNmZTQ2Y2M2YiIsImlkIjoiNWU2MTg3NmEzNWZkMmY4M2ZlNDZjYzZjIiwic2VjcmV0IjoiN2o1OHBBPT0ifQ.ia5fpRQCemKlDZSS9qJiUFZt0d8pAe6QgwogKZpp9Ak

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876a35fd2f83fe46cc6a",
  "type": "CodeSolution",
  "data": {
    "id": "5e61876a35fd2f83fe46cc6a",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-03-05T23:11:42.280Z",
    "challengeId": "5e61876a35fd2f83fe46cc7a",
    "assessmentResultId": "5e61876a35fd2f83fe46cc7e",
    "assessmentId": "5e61876a35fd2f83fe46cc76",
    "candidateId": "5e61876a35fd2f83fe46cc6c",
    "teamCandidateId": "5e61876a35fd2f83fe46cc6d",
    "teamId": "5e61876a35fd2f83fe46cc64",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2020-03-05T23:12:42.280Z",
    "completedAt": "2020-03-05T23:12:42.280Z",
    "code": "var a = 1;",
    "testCases": "Test.assertEquals(a, 1)",
    "testFramework": "cw-2",
    "attempts": 1,
    "output": [
      {
        "t": "passed",
        "v": "Test Passed"
      }
    ],
    "wallTime": 40,
    "firstTestCompletedIn": 60.0,
    "completedIn": 60.0,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 100.0
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:42.625-08:00",
    "includes": []
  }
}

Create

Creates a new solution of the type specified. This is an alias endpoint for the subtype specific route. See each type specific section for more details. For this example, this route is actually linking to the POST /v1/code_solutions route.

Endpoint

POST /v1/solutions

Parameters

Name Description
data.$type required The type of solution to create
data.language required initial language the user started in
data.assessment_result_id required data.assessment result
data.challenge_id required data.challenge

Request

Route

POST /v1/solutions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZhMzVmZDJmODNmZTQ2Y2M5MyIsImlkIjoiNWU2MTg3NmEzNWZkMmY4M2ZlNDZjYzk0Iiwic2VjcmV0IjoiNXlVTmNBPT0ifQ.0DIwzBP6tkhsiPbfMHMOJftejld17bm1_o7hTxSvvRw

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5e61876a35fd2f83fe46cc92",
    "challenge_id": "5e61876a35fd2f83fe46cc8e",
    "language": "javascript"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876b35fd2f83fe46cc99",
  "type": "CodeSolution",
  "data": {
    "id": "5e61876b35fd2f83fe46cc99",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-03-05T23:12:43.122Z",
    "challengeId": "5e61876a35fd2f83fe46cc8e",
    "assessmentResultId": "5e61876a35fd2f83fe46cc92",
    "assessmentId": "5e61876a35fd2f83fe46cc8a",
    "candidateId": "5e61876a35fd2f83fe46cc94",
    "teamCandidateId": "5e61876a35fd2f83fe46cc95",
    "teamId": "5e61876a35fd2f83fe46cc84",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": "var a = ",
    "testCases": "Test.expect(a == 1)",
    "testFramework": "cw-2",
    "attempts": 0,
    "output": null,
    "wallTime": null,
    "firstTestCompletedIn": null,
    "completedIn": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 0,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:43.146-08:00",
    "includes": []
  }
}

Fetch or Create

Fetches or creates a new solution of the type specified. This is an alias endpoint for the subtype specific route. See each type specific section for more details. For this example, this route is actually linking to the POST /v1/code_solutions route.

Endpoint

POST /v1/solutions

Parameters

Name Description
data.$type required The type of solution to create
data.language required initial language the user started in
data.assessment_result_id required data.assessment result
data.challenge_id required data.challenge

Request

Route

POST /v1/solutions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZiMzVmZDJmODNmZTQ2Y2NhYiIsImlkIjoiNWU2MTg3NmIzNWZkMmY4M2ZlNDZjY2FjIiwic2VjcmV0IjoibGYzYUlnPT0ifQ.MJFwhcZH9pNkjC8IFgUs44qg-GjeSjqYV_u8jnQQv9o

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5e61876b35fd2f83fe46ccaa",
    "challenge_id": "5e61876b35fd2f83fe46cca6",
    "language": "javascript"
  },
  "fetch": true
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876b35fd2f83fe46ccb1",
  "type": "CodeSolution",
  "data": {
    "id": "5e61876b35fd2f83fe46ccb1",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-03-05T23:12:43.664Z",
    "challengeId": "5e61876b35fd2f83fe46cca6",
    "assessmentResultId": "5e61876b35fd2f83fe46ccaa",
    "assessmentId": "5e61876b35fd2f83fe46cca2",
    "candidateId": "5e61876b35fd2f83fe46ccac",
    "teamCandidateId": "5e61876b35fd2f83fe46ccad",
    "teamId": "5e61876b35fd2f83fe46cc9c",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": null,
    "testCases": null,
    "testFramework": "cw-2",
    "attempts": 0,
    "output": null,
    "wallTime": null,
    "firstTestCompletedIn": null,
    "completedIn": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 0,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:43.706-08:00",
    "includes": []
  }
}

Update

This route is used as an alias to the subtype specific update. For example, this example maps to PUT /code_solutions/:id

Endpoint

PUT /v1/solutions/:id

Parameters

Name Description
data.$type required The type of solution to create
data.language The language that the user is taking the challenge in
data.code The user's solution code
data.test_cases The user's test case code
data.tag a revision tag
data.message a revision message

Request

Route

PUT /v1/solutions/5e61876b35fd2f83fe46ccba

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZiMzVmZDJmODNmZTQ2Y2NiYiIsImlkIjoiNWU2MTg3NmIzNWZkMmY4M2ZlNDZjY2JjIiwic2VjcmV0IjoiK1Y5YytBPT0ifQ.AWwBnV5Hp8mf61RZc2TnToWs40ewU8pEKLpYmCT2Dx0

Body

{
  "data": {
    "$type": "CodeSolution",
    "code": "var b = a = 1;",
    "tag": "paste"
  },
  "includes": [
    "revisions"
  ]
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876b35fd2f83fe46ccba",
  "type": "CodeSolution",
  "data": {
    "id": "5e61876b35fd2f83fe46ccba",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-03-05T23:11:43.988Z",
    "challengeId": "5e61876c35fd2f83fe46ccca",
    "assessmentResultId": "5e61876c35fd2f83fe46ccce",
    "assessmentId": "5e61876c35fd2f83fe46ccc6",
    "candidateId": "5e61876b35fd2f83fe46ccbc",
    "teamCandidateId": "5e61876b35fd2f83fe46ccbd",
    "teamId": "5e61876b35fd2f83fe46ccb4",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2020-03-05T23:12:43.988Z",
    "completedAt": "2020-03-05T23:12:43.988Z",
    "code": "var b = a = 1;",
    "testCases": "Test.assertEquals(a, 1)",
    "testFramework": "cw-2",
    "attempts": 1,
    "output": [
      {
        "t": "passed",
        "v": "Test Passed"
      }
    ],
    "wallTime": 40,
    "firstTestCompletedIn": 60.0,
    "completedIn": 60.0,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 2,
    "score": 100.0,
    "revisions": [
      {
        "id": "5e61876c35fd2f83fe46ccd2",
        "createdAt": "2020-03-05T23:11:43.988Z",
        "number": 0,
        "message": null,
        "tag": null,
        "revisedAttributes": {
          "output": [
            {
              "t": "passed",
              "v": "Test Passed"
            }
          ],
          "wall_time": 40,
          "specs": null,
          "assertions": null,
          "passed_test_cases": 1,
          "response": null,
          "test_response": null,
          "test_attempts": 0,
          "test_passed_test_cases": 0,
          "test_total_test_cases": 0,
          "test_output": null,
          "test_wall_time": null,
          "code": "var a = 1;",
          "test_cases": "Test.assertEquals(a, 1)",
          "language": "javascript",
          "attempts": 1,
          "first_test_case_solved_at": "2020-03-05T23:12:43.988Z",
          "completed_at": "2020-03-05T23:12:43.988Z",
          "reopened_count": 0,
          "cursor": {}
        }
      },
      {
        "id": "5e61876c35fd2f83fe46ccd3",
        "createdAt": "2020-03-05T23:12:44.313Z",
        "number": 1,
        "message": null,
        "tag": "paste",
        "revisedAttributes": {
          "code": "var b = a = 1;"
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:44.365-08:00",
    "includes": [
      "revisions"
    ]
  }
}

Team Candidate Briefs

Briefs are living report information. They are synced in the background after information related to a team candidate is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/team_candidate_briefs

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/team_candidate_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZkMzVmZDJmODNmZTQ2Y2NmNCIsImlkIjoiNWU2MTg3NmQzNWZkMmY4M2ZlNDZjY2Y1Iiwic2VjcmV0IjoiQnZuaFVRPT0ifQ.818XHF9EB7AQoMYULJpZOFPnp_7uTjOqV53AHoMm27A

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamCandidateBrief",
  "data": [
    {
      "id": "5e61876d35fd2f83fe46cd02",
      "createdAt": "2020-03-05T23:12:45.287Z",
      "updatedAt": "2020-03-05T23:12:45.356Z",
      "teamId": "5e61876d35fd2f83fe46ccf8",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-03-05T23:12:46.356Z",
      "syncs": 1,
      "teamCandidateId": "5e61876d35fd2f83fe46cd01",
      "candidateId": null,
      "firstName": "Joe",
      "lastName": "Smith657",
      "name": "Joe Smith657",
      "sortName": "Smith657, Joe",
      "anonymousName": "Fuchsia Capybara",
      "email": "[email protected]",
      "state": "invited",
      "sortState": "1",
      "prevState": null,
      "nonArchivedState": "invited",
      "blinding": "blind_reviewers",
      "stems": "j jo joe s sm smi smit smith smith6 smith65 smith657 l lo log logi login logini loginid loginide e ex exa exam examp exampl example f fu fuc fuch fuchs fuchsi fuchsia c ca cap capy capyb capyba capybar capybara",
      "labels": null,
      "languages": [],
      "redFlags": [],
      "assessmentResultReviews": [],
      "assessmentResults": [],
      "assignedTeamMemberIds": [],
      "reviewedByIds": [],
      "testTeamMember": false,
      "demoData": false,
      "forgotten": null,
      "recentlyAbandoned": false,
      "stateUpdatedAt": "2020-03-05T23:12:45.259Z",
      "teamCandidateUpdatedAt": "2020-03-05T23:12:45.259Z",
      "interactSessionsCount": 0,
      "solutionsCount": 0,
      "submittedAssessmentResultsCount": 0,
      "avgSubmissionScore": null,
      "risks": {
        "total": 0,
        "max": null
      },
      "sortScore": 0.0,
      "selectionScore": 0.0,
      "knownScore": null,
      "confidenceScore": null,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 0,
      "signalRatingsCount": 0,
      "signalBands": {
        "signals_score": {},
        "strength": {},
        "strength_score": {},
        "tag_score": {}
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:45.453-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/team_candidate_briefs/:id

Request

Route

GET /v1/team_candidate_briefs/5e61876d35fd2f83fe46cd11

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZkMzVmZDJmODNmZTQ2Y2QwNCIsImlkIjoiNWU2MTg3NmQzNWZkMmY4M2ZlNDZjZDA1Iiwic2VjcmV0IjoiUTJFaUxRPT0ifQ.euuUJL_2yrAWfpcw8PoQLoaVu11404YJIFh30-eizpA

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61876d35fd2f83fe46cd12",
  "type": "TeamCandidateBrief",
  "data": {
    "id": "5e61876d35fd2f83fe46cd12",
    "createdAt": "2020-03-05T23:12:45.722Z",
    "updatedAt": "2020-03-05T23:12:45.820Z",
    "teamId": "5e61876d35fd2f83fe46cd08",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-03-05T23:12:46.819Z",
    "syncs": 1,
    "teamCandidateId": "5e61876d35fd2f83fe46cd11",
    "candidateId": null,
    "firstName": "Joe",
    "lastName": "Smith659",
    "name": "Joe Smith659",
    "sortName": "Smith659, Joe",
    "anonymousName": "Mahogany Reindeer",
    "email": "[email protected]",
    "state": "invited",
    "sortState": "1",
    "prevState": null,
    "nonArchivedState": "invited",
    "blinding": "blind_reviewers",
    "stems": "j jo joe s sm smi smit smith smith6 smith65 smith659 l lo log logi login logini loginid loginide e ex exa exam examp exampl example m ma mah maho mahog mahoga mahogan mahogany r re rei rein reind reinde reindee reindeer",
    "labels": null,
    "languages": [],
    "redFlags": [],
    "assessmentResultReviews": [],
    "assessmentResults": [],
    "assignedTeamMemberIds": [],
    "reviewedByIds": [],
    "testTeamMember": false,
    "demoData": false,
    "forgotten": null,
    "recentlyAbandoned": false,
    "stateUpdatedAt": "2020-03-05T23:12:45.692Z",
    "teamCandidateUpdatedAt": "2020-03-05T23:12:45.692Z",
    "interactSessionsCount": 0,
    "solutionsCount": 0,
    "submittedAssessmentResultsCount": 0,
    "avgSubmissionScore": null,
    "risks": {
      "total": 0,
      "max": null
    },
    "sortScore": 0.0,
    "selectionScore": 0.0,
    "knownScore": null,
    "confidenceScore": null,
    "opinionScore": null,
    "knownObjectivesScore": null,
    "knownQualitiesScore": null,
    "signalBandsCount": 0,
    "signalRatingsCount": 0,
    "signalBands": {
      "signals_score": {},
      "strength": {},
      "strength_score": {},
      "tag_score": {}
    }
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:45.849-08:00",
    "includes": []
  }
}

Team Candidates

List

Endpoint

GET /v1/team_candidates

Parameters

Name Description
includes Valid values are: assessments, assessment_results, solutions

Request

Route

GET /v1/team_candidates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzZlMzVmZDJmODNmZTQ2Y2QzMyIsImlkIjoiNWU2MTg3NmUzNWZkMmY4M2ZlNDZjZDM0Iiwic2VjcmV0IjoiNVFuS29RPT0ifQ.VqM0ydklZ0-yM44JkvVJDXQNr63FUmtWpv66O5jZfoY

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamCandidate",
  "data": [
    {
      "id": "5e61876d35fd2f83fe46cd16",
      "candidateId": "5e61876d35fd2f83fe46cd15",
      "teamId": "5e61876e35fd2f83fe46cd19",
      "state": "started",
      "demoData": false,
      "prevState": null,
      "assessmentIds": [
        "5e61876e35fd2f83fe46cd1f",
        "5e61876e35fd2f83fe46cd2b"
      ],
      "assessmentResultIds": [
        "5e61876e35fd2f83fe46cd27",
        "5e61876e35fd2f83fe46cd30"
      ],
      "blinding": "blind_reviewers",
      "createdAt": "2020-03-05T23:12:46.053Z",
      "updatedAt": "2020-03-05T23:12:46.376Z",
      "decidedAt": null,
      "invitedAt": null,
      "interactSessions": 0,
      "stateUpdatedAt": "2020-03-05T23:12:46.053Z",
      "testTeamMember": false,
      "assignedTeamMemberIds": [],
      "labels": null,
      "archived": false,
      "firstName": "Joe",
      "lastName": "Smith660",
      "anonymousName": "Teal Heron",
      "email": "[email protected]",
      "name": "Joe Smith660",
      "isBlinded": false,
      "stateLabel": "Assessment Started",
      "angelId": null,
      "stateTransitions": [
        "idle",
        "invited",
        "started",
        "submitted",
        "risk_detected",
        "reviewed",
        "approved",
        "rejected",
        "archived"
      ],
      "risks": null,
      "assessmentsRecap": {
        "id": "5e61876e35fd2f83fe46cd29",
        "subjects": [
          {
            "id": "5e61876e35fd2f83fe46cd2a",
            "assessmentResultId": "5e61876e35fd2f83fe46cd27",
            "assessmentId": "5e61876e35fd2f83fe46cd1f",
            "state": "started"
          },
          {
            "id": "5e61876e35fd2f83fe46cd32",
            "assessmentResultId": "5e61876e35fd2f83fe46cd30",
            "assessmentId": "5e61876e35fd2f83fe46cd2b",
            "state": "started"
          }
        ]
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:12:46.486-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/team_candidates/:id

Parameters

Name Description
id required Object ID
includes Valid values are: assessments, assessment_results, solutions, team

Request

Route

GET /v1/team_candidates/5e61877135fd2f83fe46cdde

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzcxMzVmZDJmODNmZTQ2Y2RmYiIsImlkIjoiNWU2MTg3NzEzNWZkMmY4M2ZlNDZjZGZjIiwic2VjcmV0IjoiTVRsOXpBPT0ifQ.0e8YjFHVZonU7yB1xaazMwX3dg6O-RWUbyHJb_hVgCU

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877135fd2f83fe46cdde",
  "type": "TeamCandidate",
  "data": {
    "id": "5e61877135fd2f83fe46cdde",
    "candidateId": "5e61877135fd2f83fe46cddd",
    "teamId": "5e61877135fd2f83fe46cde1",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5e61877135fd2f83fe46cde7",
      "5e61877135fd2f83fe46cdf3"
    ],
    "assessmentResultIds": [
      "5e61877135fd2f83fe46cdef",
      "5e61877135fd2f83fe46cdf8"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-03-05T23:12:49.595Z",
    "updatedAt": "2020-03-05T23:12:49.906Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-03-05T23:12:49.595Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Joe",
    "lastName": "Smith677",
    "anonymousName": "Maroon Wolf",
    "email": "[email protected]",
    "name": "Joe Smith677",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "angelId": null,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5e61877135fd2f83fe46cdf1",
      "subjects": [
        {
          "id": "5e61877135fd2f83fe46cdf2",
          "assessmentResultId": "5e61877135fd2f83fe46cdef",
          "assessmentId": "5e61877135fd2f83fe46cde7",
          "state": "started"
        },
        {
          "id": "5e61877135fd2f83fe46cdfa",
          "assessmentResultId": "5e61877135fd2f83fe46cdf8",
          "assessmentId": "5e61877135fd2f83fe46cdf3",
          "state": "started"
        }
      ]
    }
  },
  "meta": {
    "enums": {
      "blinding": [
        {
          "value": "none",
          "text": "None"
        },
        {
          "value": "blind_reviewers",
          "text": "Blind reviewers"
        },
        {
          "value": "restricted",
          "text": "Restricted"
        },
        {
          "value": "team",
          "text": "Team"
        }
      ],
      "state": [
        {
          "value": "idle",
          "text": "Idle"
        },
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Assessment Started"
        },
        {
          "value": "submitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "risk_detected",
          "text": "Plagiarism Risk Detected"
        },
        {
          "value": "reviewed",
          "text": "Assessment Reviewed"
        },
        {
          "value": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2020-03-05T15:12:49.989-08:00",
    "includes": []
  }
}

Update

Updates basic info for a team candidate.

Endpoint

PUT /v1/team_candidates/:id

Parameters

Name Description
data.email A valid email
data.first_name data.first name
data.last_name data.last name
data.state Valid values are: started, submitted, approved, rejected

Request

Route

PUT /v1/team_candidates/5e61877335fd2f83fe46ce38

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzczMzVmZDJmODNmZTQ2Y2U1NSIsImlkIjoiNWU2MTg3NzMzNWZkMmY4M2ZlNDZjZTU2Iiwic2VjcmV0IjoiOXJkcUd3PT0ifQ.CDGd2ZXU14na91uIFB4hI9PiuiXSSfEUbFM2bsfQOy4

Body

{
  "data": {
    "first_name": "Test",
    "last_name": "Time"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877335fd2f83fe46ce38",
  "type": "TeamCandidate",
  "data": {
    "id": "5e61877335fd2f83fe46ce38",
    "candidateId": "5e61877335fd2f83fe46ce37",
    "teamId": "5e61877335fd2f83fe46ce3b",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5e61877335fd2f83fe46ce41",
      "5e61877335fd2f83fe46ce4d"
    ],
    "assessmentResultIds": [
      "5e61877335fd2f83fe46ce49",
      "5e61877335fd2f83fe46ce52"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-03-05T23:12:51.342Z",
    "updatedAt": "2020-03-05T23:12:51.698Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-03-05T23:12:51.342Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": [],
    "archived": false,
    "firstName": "Test",
    "lastName": "Time",
    "anonymousName": "Navy Tiger",
    "email": "[email protected]",
    "name": "Test Time",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "angelId": null,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5e61877335fd2f83fe46ce4b",
      "subjects": [
        {
          "id": "5e61877335fd2f83fe46ce4c",
          "assessmentResultId": "5e61877335fd2f83fe46ce49",
          "assessmentId": "5e61877335fd2f83fe46ce41",
          "state": "started"
        },
        {
          "id": "5e61877335fd2f83fe46ce54",
          "assessmentResultId": "5e61877335fd2f83fe46ce52",
          "assessmentId": "5e61877335fd2f83fe46ce4d",
          "state": "started"
        }
      ]
    }
  },
  "meta": {
    "enums": {
      "blinding": [
        {
          "value": "none",
          "text": "None"
        },
        {
          "value": "blind_reviewers",
          "text": "Blind reviewers"
        },
        {
          "value": "restricted",
          "text": "Restricted"
        },
        {
          "value": "team",
          "text": "Team"
        }
      ],
      "state": [
        {
          "value": "idle",
          "text": "Idle"
        },
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Assessment Started"
        },
        {
          "value": "submitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "risk_detected",
          "text": "Plagiarism Risk Detected"
        },
        {
          "value": "reviewed",
          "text": "Assessment Reviewed"
        },
        {
          "value": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2020-03-05T15:12:51.786-08:00",
    "includes": []
  }
}

Bulk Update

Endpoint

POST /v1/team_candidates/bulk_update

Parameters

Name Description
ids required ids of team candidates to process
bulk_action required the action to take: update, approve, cancel, reject, archive, restore
data.add_labels data.add labels
data.remove_labels data.remove labels
data.add_note a note to add to all candidates

Request

Route

POST /v1/team_candidates/bulk_update

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzc0MzVmZDJmODNmZTQ2Y2U3NyIsImlkIjoiNWU2MTg3NzQzNWZkMmY4M2ZlNDZjZTc4Iiwic2VjcmV0IjoiUG1RVWZBPT0ifQ.-7aYJXBI2RTrHMTSLCOZj8p7duLeMtpclccVMP-bKH8

Body

{
  "ids": [
    "5e61877335fd2f83fe46ce5a",
    "5e61877435fd2f83fe46ce7c"
  ],
  "bulk_action": "archive",
  "data": {
    "add_labels": [
      "Bulk Archived"
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877435fd2f83fe46ce7d",
  "type": "TeamCandidateBulkEditOperation",
  "data": {
    "id": "5e61877435fd2f83fe46ce7d",
    "action": "archive",
    "createdAt": "2020-03-05T23:12:52.422Z",
    "lastCompletionAt": null,
    "totalCount": 2,
    "completedCount": 0,
    "todoCount": 2,
    "completionPercentage": 0.0
  },
  "meta": {
    "timestamp": "2020-03-05T15:12:52.592-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/team_candidates/:id

Parameters

Name Description
id required base16 ObjectId

Request

Route

DELETE /v1/team_candidates/5e61877a35fd2f83fe46cfbb

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzdhMzVmZDJmODNmZTQ2Y2ZkOSIsImlkIjoiNWU2MTg3N2EzNWZkMmY4M2ZlNDZjZmRhIiwic2VjcmV0IjoiaUdnbjJBPT0ifQ.-S0bsXMClvuhFj2AORspaDZs2eVtZHgTyEl8F7Dkidc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Team Members

List

Returns all non-staff members for admins

Endpoint

GET /v1/team_members

Request

Route

GET /v1/team_members

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzdiMzVmZDJmODNmZTQ2ZDAyNCIsImlkIjoiNWU2MTg3N2IzNWZkMmY4M2ZlNDZkMDI1Iiwic2VjcmV0IjoiQzU0SWNBPT0ifQ.pZTLLF6IQTKxQ8tPHGd8kAFiZ_W88FYNBCbxqchvVWA

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamMember",
  "data": [
    {
      "id": "5e61877b35fd2f83fe46d01c",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith741",
      "name": "Joe Smith741",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-03-05T23:12:59.906Z",
      "updatedAt": "2020-03-05T23:12:59.906Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_PrubhsFc8eGwgiQYCKhb2g",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "jUrN40L7S6hekw.5e61877b35fd2f83fe46d01c",
      "teamId": "5e61877b35fd2f83fe46d00f",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2020-03-05T23:12:59.903Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5e61877b35fd2f83fe46d01d",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5e61877b35fd2f83fe46d019",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith740",
      "name": "Joe Smith740",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-03-05T23:12:59.881Z",
      "updatedAt": "2020-03-05T23:12:59.881Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_rissPAEZQqsKbrMFiKWdpQ",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "0ab5zZfop3zsiA.5e61877b35fd2f83fe46d019",
      "teamId": "5e61877b35fd2f83fe46d00f",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2020-03-05T23:12:59.877Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5e61877b35fd2f83fe46d01a",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5e61877b35fd2f83fe46d016",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith739",
      "name": "Joe Smith739",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-03-05T23:12:59.854Z",
      "updatedAt": "2020-03-05T23:12:59.854Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_zDDekBrTCdjxOgTgtk0dYg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "SO5UWY4hd4cL5g.5e61877b35fd2f83fe46d016",
      "teamId": "5e61877b35fd2f83fe46d00f",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2020-03-05T23:12:59.850Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5e61877b35fd2f83fe46d017",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5e61877b35fd2f83fe46d00b",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith738",
      "name": "Joe Smith738",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-03-05T23:12:59.768Z",
      "updatedAt": "2020-03-05T23:12:59.768Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_sKarm4eVwrwZDcg3jfWgFg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "RpTpgfzFcAeASw.5e61877b35fd2f83fe46d00b",
      "teamId": "5e61877b35fd2f83fe46d001",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2020-03-05T23:12:59.764Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5e61877b35fd2f83fe46d00c",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5e61877b35fd2f83fe46d008",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith737",
      "name": "Joe Smith737",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-03-05T23:12:59.724Z",
      "updatedAt": "2020-03-05T23:12:59.724Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_N2vztwYmFskMh4yeAWLWbg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "xs6QRrXiZbZ9ow.5e61877b35fd2f83fe46d008",
      "teamId": "5e61877b35fd2f83fe46d001",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2020-03-05T23:12:59.719Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5e61877b35fd2f83fe46d009",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2020-03-05T15:13:00.044-08:00",
    "includes": []
  }
}

Get

Returns the team member account if the current user can view it

Endpoint

GET /v1/team_members/:id

Parameters

Name Description
includes Valid values are: team, authored_challenges, authored_assessments

Request

Route

GET /v1/team_members/5e61877d35fd2f83fe46d0a0?includes[]=team&includes[]=authored_challenges&includes[]=authored_assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzdkMzVmZDJmODNmZTQ2ZDBhMiIsImlkIjoiNWU2MTg3N2QzNWZkMmY4M2ZlNDZkMGEzIiwic2VjcmV0IjoiTktBM1R3PT0ifQ.-KO5co9KolAoU9ZcrHJkejVl60176w3pwVoFgFY2wPo

Query Parameters

includes=["team", "authored_challenges", "authored_assessments"]

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877d35fd2f83fe46d0a0",
  "type": "TeamMember",
  "data": {
    "id": "5e61877d35fd2f83fe46d0a0",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith766",
    "name": "Joe Smith766",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-03-05T23:13:01.643Z",
    "updatedAt": "2020-03-05T23:13:01.643Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_nDzXfRz5ujSGPZrjZhbr3A",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "fesDJZVzzkC2xQ.5e61877d35fd2f83fe46d0a0",
    "teamId": "5e61877d35fd2f83fe46d099",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "team": {
      "id": "5e61877d35fd2f83fe46d099",
      "name": "team314",
      "updatedAt": "2020-03-05T23:13:01.582Z",
      "highConcept": null,
      "website": null,
      "productTypes": {
        "_id": "5e61877d35fd2f83fe46d09c",
        "education": true,
        "recruitment": true
      },
      "customerId": "5e61877d35fd2f83fe46d097",
      "hasDemoData": false,
      "buildingDemoData": false,
      "destroyingDemoData": false,
      "surveysDisabled": null,
      "defaultEnableExternalIde": true,
      "labs": {
        "externalIde": false,
        "angellistSourcing": false
      },
      "logoImg": {
        "id": "5e61877d35fd2f83fe46d09b",
        "fileId": "axaO0A",
        "fileFormat": "jpg",
        "width": 500,
        "height": 500,
        "url": "//res.cloudinary.com/strive/image/upload/axaO0A.jpg",
        "rawUrl": "https://s3-us-west-1.amazonaws.com/strive-uploads/axaO0A.jpg",
        "size": null,
        "brightness": null,
        "background": null
      },
      "createdAt": "2020-03-05T23:13:01.582Z",
      "state": "inactive",
      "assessmentsEnabled": true,
      "publishedAssessmentCount": 0,
      "assessmentResultCount": 0,
      "growthSpeed": "high_growth",
      "companySize": null,
      "engineeringTeamSize": null,
      "referenceInfo": null,
      "notificationScheme": "entire_team",
      "setupAssessmentId": null,
      "setupComplete": false,
      "desiredLanguages": null,
      "assessmentNounUpper": "Assessment",
      "showReviewsToReviewers": false,
      "unblindAfterDecision": false,
      "loginProviders": [
        "qualified"
      ],
      "primaryTeam": true,
      "bambooConfig": {
        "id": "5e61877d35fd2f83fe46d0a4",
        "subdomain": null,
        "url": null,
        "jobStatuses": null,
        "jobs": null,
        "lastPollAt": null
      },
      "bambooConnected": false,
      "apiKey": null,
      "zapierApiKey": null,
      "greenhouseApiKey": null,
      "workableApiKey": null,
      "hasBlindReviewers": false,
      "msaSigned": false,
      "desiredFeatures": {
        "id": "5e61877d35fd2f83fe46d09e",
        "takeHome": true
      },
      "progressEvents": {
        "id": "5e61877d35fd2f83fe46d0a5"
      },
      "nameWasGenerated": false,
      "teamMemberRoleCounts": {
        "owner": 1
      },
      "desiredIntegration": null,
      "desiredIntegrationIsCurrent": null,
      "evaluatedCandidatesMonthly": null,
      "evaluatedCandidatesYearly": null,
      "msaSignedAt": null,
      "msaSignedById": null,
      "samlIssuer": null,
      "samlMetadata": null,
      "samlMetadataUrl": null,
      "utmTracking": {
        "id": "5e61877d35fd2f83fe46d09d",
        "utmSource": "qualified"
      }
    },
    "activatedAt": "2020-03-05T23:13:01.639Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5e61877d35fd2f83fe46d0a1",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "authoredAssessments": [],
    "authoredChallenges": [],
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-03-05T15:13:01.733-08:00",
    "includes": [
      "team",
      "authored_challenges",
      "authored_assessments"
    ]
  }
}

Create

Creates a new team member user. This API is allowed only for authenticated admin and team owners.

Endpoint

POST /v1/team_members

Parameters

Name Description
data.email required A valid email
data.first_name required data.first name
data.last_name required data.last name
data.password data.password
data.bio data.bio
data.teamId required The team must be created first. Not required if team member is authenticated user
data.ui_prefs A json object for storing custom client-side preferences

Request

Route

POST /v1/team_members

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzdkMzVmZDJmODNmZTQ2ZDBhNiIsImlkIjoiNWU2MTg3N2QzNWZkMmY4M2ZlNDZkMGE3Iiwic2VjcmV0IjoicmNYU3JnPT0ifQ.NiF4AWlMrk67imzHgo5h-N81VSpFbVV1e1b6DRQLros

Body

{
  "data": {
    "first_name": "Joe",
    "last_name": "Smith",
    "password": "password",
    "email": "[email protected]",
    "team_id": "5e61877d35fd2f83fe46d0aa"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877d35fd2f83fe46d0b1",
  "type": "TeamMember",
  "data": {
    "id": "5e61877d35fd2f83fe46d0b1",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith",
    "name": "Joe Smith",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-03-05T23:13:01.943Z",
    "updatedAt": "2020-03-05T23:13:01.943Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_YLpEwYyEWLUytaYxbYBVpQ",
    "hasPassword": false,
    "intercomUrl": null,
    "confirmationToken": "VKwV7CNWkOJ4WQ.5e61877d35fd2f83fe46d0b1",
    "teamId": "5e61877d35fd2f83fe46d0aa",
    "role": "owner",
    "state": "invited",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2020-03-05T23:13:01.944Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5e61877d35fd2f83fe46d0b2",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-03-05T15:13:01.956-08:00",
    "includes": []
  }
}

Update

Updates a team member.

Endpoint

PUT /v1/team_members/:id

Parameters

Name Description
data.email A valid email
data.first_name data.first name
data.last_name data.last name
data.suffix data.suffix
data.bio data.bio
data.ui_prefs A json object for storing custom client-side preferences

Request

Route

PUT /v1/team_members/5e61877e35fd2f83fe46d0b6

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4NzdlMzVmZDJmODNmZTQ2ZDBiMyIsImlkIjoiNWU2MTg3N2UzNWZkMmY4M2ZlNDZkMGI0Iiwic2VjcmV0IjoiYy9XWVhRPT0ifQ.0AdV1ZydZhPatphzxV8pUtaTu0PYo3v6P6DHhz91uQQ

Body

{
  "data": {
    "first_name": "Test",
    "last_name": "Time",
    "uiPrefs": {
      "theme": "dark"
    }
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61877e35fd2f83fe46d0b6",
  "type": "TeamMember",
  "data": {
    "id": "5e61877e35fd2f83fe46d0b6",
    "$type": "TeamMember",
    "firstName": "Test",
    "lastName": "Time",
    "name": "Test Time",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-03-05T23:13:02.144Z",
    "updatedAt": "2020-03-05T23:13:02.198Z",
    "uiPrefs": {
      "theme": "dark"
    },
    "experiments": null,
    "envRoomId": "test_v0rr5UhQgpxbib0rFymWyw",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "FOz8SQbHg8YUEg.5e61877e35fd2f83fe46d0b6",
    "teamId": "5e61877e35fd2f83fe46d0b9",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2020-03-05T23:13:02.056Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5e61877e35fd2f83fe46d0bf",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-03-05T15:13:02.205-08:00",
    "includes": []
  }
}

Webhook Examples

Resources for simulating and firing webhooks for a given resource and event. Note that the data returned is in snake case, as opposed to camel case. This is because webhook data does not support camel casing, unlike the data normally returned by the API.

Simulate Team Candidate Started Assessment Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5e61878635fd2f83fe46d3c5?type=AssessmentResult&event=team_candidate.started_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg2MzVmZDJmODNmZTQ2ZDNiNSIsImlkIjoiNWU2MTg3ODYzNWZkMmY4M2ZlNDZkM2I2Iiwic2VjcmV0IjoiZk9FRjl3PT0ifQ.PM02e_Fqj0RO79nvX4lObn-VmFktynT2DVq1PdeDgKE

Query Parameters

type=AssessmentResult
event=team_candidate.started_assessment

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_started_assessment",
  "data": {
    "abandoned": false,
    "accumulated_seconds": 0,
    "browser_user_agent": null,
    "candidate_remarks": null,
    "dry_run": false,
    "invited_at": null,
    "redirect_url": null,
    "review_ratings": {},
    "score": 0.0,
    "started_at": "2020-03-05T23:13:10.368Z",
    "state": "started",
    "submitted_at": null,
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5e61878635fd2f83fe46d3c5",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith801"
    },
    "team_candidate": {
      "anonymous_name": "Yellow Muskox",
      "prev_state": null,
      "state": "started",
      "id": "5e61878635fd2f83fe46d3c8"
    },
    "assessment": {
      "labels": null,
      "title": "Mid-Level Web Engineer #250",
      "id": "5e61878635fd2f83fe46d3c0"
    },
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-03-05T23:13:10.417Z",
        "first_test_case_solved_at": "2020-03-05T23:13:10.417Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5e61878635fd2f83fe46d3cc",
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Actor Encoding #355",
          "estimated_time": 2,
          "topics": [
            "Logic"
          ],
          "summary": null,
          "purpose": null,
          "id": "5e61878635fd2f83fe46d3c1"
        }
      }
    ]
  }
}

Simulate Team Candidate Submitted Assessment Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5e61878635fd2f83fe46d3de?type=AssessmentResult&event=team_candidate.submitted_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg2MzVmZDJmODNmZTQ2ZDNjZSIsImlkIjoiNWU2MTg3ODYzNWZkMmY4M2ZlNDZkM2NmIiwic2VjcmV0IjoiZWxtOW1BPT0ifQ.E4GQPorBIGf46UTVF88zAxeOCaOuvxba6QvO8JHp5bA

Query Parameters

type=AssessmentResult
event=team_candidate.submitted_assessment

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_submitted_assessment",
  "data": {
    "abandoned": false,
    "accumulated_seconds": 0,
    "browser_user_agent": null,
    "candidate_remarks": null,
    "dry_run": false,
    "invited_at": null,
    "redirect_url": null,
    "review_ratings": {},
    "score": 0.0,
    "started_at": null,
    "state": "submitted",
    "submitted_at": "2020-03-05T23:13:10.801Z",
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5e61878635fd2f83fe46d3de",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith803"
    },
    "team_candidate": {
      "anonymous_name": "Crimson Parrot",
      "prev_state": "invited",
      "state": "submitted",
      "id": "5e61878635fd2f83fe46d3e1"
    },
    "assessment": {
      "labels": null,
      "title": "Mid-Level Node Developer #251",
      "id": "5e61878635fd2f83fe46d3d9"
    },
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-03-05T23:13:10.851Z",
        "first_test_case_solved_at": "2020-03-05T23:13:10.851Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5e61878635fd2f83fe46d3e5",
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Utility Encoding #356",
          "estimated_time": 2,
          "topics": [
            "Algorithms"
          ],
          "summary": null,
          "purpose": null,
          "id": "5e61878635fd2f83fe46d3da"
        }
      }
    ]
  }
}

Simulate Solution Updated Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5e61878735fd2f83fe46d3f2?type=Solution&event=solution.updated

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg2MzVmZDJmODNmZTQ2ZDNlNyIsImlkIjoiNWU2MTg3ODYzNWZkMmY4M2ZlNDZkM2U4Iiwic2VjcmV0IjoiQWFJUWJRPT0ifQ.c6qCjf7HzYJu5hekuPBIp0VBN9N3MVr3gpRPewcdnzA

Query Parameters

type=Solution
event=solution.updated

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "solution_updated",
  "data": {
    "_type": "CodeSolution",
    "assessment_id": "5e61878735fd2f83fe46d3fe",
    "assessment_result_id": "5e61878735fd2f83fe46d406",
    "attempts": 1,
    "completed_at": "2020-03-05T23:13:11.162Z",
    "first_test_case_solved_at": "2020-03-05T23:13:11.162Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5e61878735fd2f83fe46d3f5",
    "team_id": "5e61878735fd2f83fe46d3eb",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5e61878735fd2f83fe46d3f2",
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Fibonacci Algorithm #357",
      "estimated_time": 2,
      "topics": [
        "Meta-programming"
      ],
      "summary": null,
      "purpose": null,
      "id": "5e61878735fd2f83fe46d402"
    }
  }
}

Simulate Team Candidate State Changed Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5e61878735fd2f83fe46d418?type=TeamCandidate&event=team_candidate.state_changed

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg3MzVmZDJmODNmZTQ2ZDQwYiIsImlkIjoiNWU2MTg3ODczNWZkMmY4M2ZlNDZkNDBjIiwic2VjcmV0IjoiSnlOcnZRPT0ifQ.6AqJQvi1yoyCb2vDJ6cRhx_-hXxLbMotFW5UaPcfkDI

Query Parameters

type=TeamCandidate
event=team_candidate.state_changed

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_state_changed",
  "data": {
    "anonymous_name": "Mahogany Mockingbird",
    "email": "[email protected]",
    "first_name": "Joe",
    "labels": null,
    "last_name": "Smith808",
    "name": "Joe Smith808",
    "prev_state": null,
    "state": "invited",
    "test_team_member": false,
    "id": "5e61878735fd2f83fe46d418",
    "highest_score": null,
    "assessment_results_count": 0
  }
}

Trigger Solution Updated Hook

Triggers a web hook to be sent to the url provided, allowing you to test what its like for the system to send hooks

Endpoint

POST /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to trigger
event required snake cased name of the event to trigger
type required Resource type name to be triggered, i.e. Challenge, Solution, TeamCandidate, Note
url required URL to send the webhook to

Request

Route

POST /v1/webhook_examples/5e61878735fd2f83fe46d425

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg3MzVmZDJmODNmZTQ2ZDQxYSIsImlkIjoiNWU2MTg3ODczNWZkMmY4M2ZlNDZkNDFiIiwic2VjcmV0IjoiQmpZdVpBPT0ifQ.tGjLONWNtUjq5qofmSruF3tayNVhrNKg7ft0CC5CSmw

Body

{
  "type": "Solution",
  "event": "solution_updated",
  "url": "https://example.com/hook"
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "solution_updated",
  "data": {
    "_type": "CodeSolution",
    "assessment_id": "5e61878835fd2f83fe46d431",
    "assessment_result_id": "5e61878835fd2f83fe46d439",
    "attempts": 1,
    "completed_at": "2020-03-05T23:13:11.951Z",
    "first_test_case_solved_at": "2020-03-05T23:13:11.951Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5e61878735fd2f83fe46d428",
    "team_id": "5e61878735fd2f83fe46d41e",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5e61878735fd2f83fe46d425",
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Sequential Parser #358",
      "estimated_time": 2,
      "topics": [
        "Fundamentals"
      ],
      "summary": null,
      "purpose": null,
      "id": "5e61878835fd2f83fe46d435"
    }
  }
}

Webhook Subscriptions

List

Endpoint

GET /v1/webhook_subscriptions

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/webhook_subscriptions

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg4MzVmZDJmODNmZTQ2ZDQzZiIsImlkIjoiNWU2MTg3ODgzNWZkMmY4M2ZlNDZkNDQwIiwic2VjcmV0IjoiNHlDSUZBPT0ifQ.Ez_M0rxFM3RY4s8BMGE30jLDCLdl5ukaV1FddgKpV50

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "WebhookSubscription",
  "data": [
    {
      "id": "5e61878835fd2f83fe46d44a",
      "name": "Default",
      "url": "https://www.test.com/obstg",
      "schema": "v1",
      "triggerOnAll": false,
      "eventTriggers": {
        "id": "5e61878835fd2f83fe46d44b",
        "challengeCreated": true
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-03-05T15:13:12.563-08:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/webhook_subscriptions/:id

Request

Route

GET /v1/webhook_subscriptions/5e61878835fd2f83fe46d457

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg4MzVmZDJmODNmZTQ2ZDQ0YyIsImlkIjoiNWU2MTg3ODgzNWZkMmY4M2ZlNDZkNDRkIiwic2VjcmV0IjoiTG9RZXd3PT0ifQ.Hx378H9IQ0JKRQZ1ZYNi8fLp_oqeoxGUbI8baGAftkw

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61878835fd2f83fe46d457",
  "type": "WebhookSubscription",
  "data": {
    "id": "5e61878835fd2f83fe46d457",
    "name": "Default",
    "url": "https://www.test.com/qolgd",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5e61878835fd2f83fe46d458",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-03-05T15:13:12.771-08:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/webhook_subscriptions

Parameters

Name Description
data.url required data.url
data.eventTriggers Object
data.triggerOnAll Boolean

Request

Route

POST /v1/webhook_subscriptions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg4MzVmZDJmODNmZTQ2ZDQ1OSIsImlkIjoiNWU2MTg3ODgzNWZkMmY4M2ZlNDZkNDVhIiwic2VjcmV0IjoiUUlmbW1BPT0ifQ.W5U1QGI6ApMiXBFB1nwFhyNbVMc2-ROFGxrfPN9cbTo

Body

{
  "data": {
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "eventTriggers": {
      "challenge_created": true
    }
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61878835fd2f83fe46d464",
  "type": "WebhookSubscription",
  "data": {
    "id": "5e61878835fd2f83fe46d464",
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5e61878835fd2f83fe46d465",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-03-05T15:13:12.977-08:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/webhook_subscriptions/:id

Parameters

Name Description
data.url required data.url
data.eventTriggers Object
data.triggerOnAll Boolean

Request

Route

PUT /v1/webhook_subscriptions/5e61878935fd2f83fe46d480

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg5MzVmZDJmODNmZTQ2ZDQ3NSIsImlkIjoiNWU2MTg3ODkzNWZkMmY4M2ZlNDZkNDc2Iiwic2VjcmV0IjoiWU5sUTd3PT0ifQ.uKGk9VkcgLrEHzZ6AibFrnQj_ddiHJdP7_a0N-krjG4

Body

{
  "data": {
    "name": "My Hook"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5e61878935fd2f83fe46d480",
  "type": "WebhookSubscription",
  "data": {
    "id": "5e61878935fd2f83fe46d480",
    "name": "My Hook",
    "url": "https://www.test.com/fmttk",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5e61878935fd2f83fe46d481",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-03-05T15:13:13.415-08:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/webhook_subscriptions/:id

Request

Route

DELETE /v1/webhook_subscriptions/5e61878935fd2f83fe46d48d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlNjE4Nzg5MzVmZDJmODNmZTQ2ZDQ4MiIsImlkIjoiNWU2MTg3ODkzNWZkMmY4M2ZlNDZkNDgzIiwic2VjcmV0IjoiMXl1OFpnPT0ifQ.RNao_jyEybOGRTahixq8qgf3lSenxRGYihgroZNhS1w
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Delete By Url

Endpoint

DELETE /v1/webhook_subscriptions/url?url=:url

Request

Route

DELETE /v1/webhook_subscriptions/url?url=https://www.test.com/njlcf

Headers

Authorization: nC7x7xD8fVxsnLEkeIb42Y5x0ggvbhYH
Content-Type: application/x-www-form-urlencoded

Query Parameters

url=https://www.test.com/njlcf

Response

Simulated Response

Status

204