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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmU4ODAxNTcxZjdlZDc0NzY3NiIsImlkIjoiNWYzNmE2ZTg4MDE1NzFmN2VkNzQ3Njc3Iiwic2VjcmV0IjoiZVRld2RRPT0ifQ.niz9qSuK4ZKI-8SRWpNBcLQmZuB3Ws9qWaD45tFC-jM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentBrief",
  "data": [
    {
      "id": "5f36a6e8801571f7ed747681",
      "createdAt": "2020-08-14T14:59:53.051Z",
      "updatedAt": "2020-08-14T14:59:53.165Z",
      "teamId": "5f36a6e8801571f7ed74767a",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T14:59:54.164Z",
      "syncs": 1,
      "title": "Senior Big-Data Developer #24",
      "labels": null,
      "state": "published",
      "enforcedTimeLimit": null,
      "suggestedEstimatedTime": 6,
      "manualEstimatedTime": null,
      "passingScore": 100,
      "demoData": false,
      "assessmentUpdatedAt": "2020-08-14T14:59:52.260Z",
      "challengesCount": 3,
      "solutionsCount": 12,
      "counts": {
        "total": 4,
        "abandoned": 0,
        "passed": 0,
        "states": {
          "started": 1,
          "submitted": 3
        },
        "closed_reasons": {
          "candidate_submitted": 3
        }
      },
      "assessmentInvitationCounts": {},
      "solutionRisks": {},
      "submissionRate": 75.0,
      "passRate": 0.0,
      "baselineStats": {
        "score": null,
        "accumulated_seconds": null,
        "accumulated_bg_seconds": null
      },
      "subjectStats": {
        "score": {
          "iqr": 0.0,
          "counts": {
            "total": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "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": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "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": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "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
          }
        }
      },
      "publishedAt": "2020-08-14T14:59:52.165Z",
      "challengeStats": [
        {
          "id": "5f36a6e8801571f7ed747682",
          "position": 1,
          "title": "Email Puzzle #38",
          "type": "CodeChallenge",
          "difficulty": 1,
          "disabledLanguages": null,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        },
        {
          "id": "5f36a6e8801571f7ed747686",
          "position": 2,
          "title": "Greedy Methods #39",
          "type": "CodeChallenge",
          "difficulty": 1,
          "disabledLanguages": null,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        },
        {
          "id": "5f36a6e8801571f7ed74768a",
          "position": 3,
          "title": "Small Events #40",
          "type": "CodeChallenge",
          "difficulty": 1,
          "disabledLanguages": null,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T10:59:53.201-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_briefs/:id

Request

Route

GET /v1/assessment_briefs/5f36a6e9801571f7ed7476bf

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmU5ODAxNTcxZjdlZDc0NzZiNCIsImlkIjoiNWYzNmE2ZTk4MDE1NzFmN2VkNzQ3NmI1Iiwic2VjcmV0IjoieThiWE9BPT0ifQ.nJbc3VjrSQXgPD-pFLzObhlv2Dl8yQWgOo4ke3EC16E

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6e9801571f7ed7476bf",
  "type": "AssessmentBrief",
  "data": {
    "id": "5f36a6e9801571f7ed7476bf",
    "createdAt": "2020-08-14T14:59:55.077Z",
    "updatedAt": "2020-08-14T14:59:55.168Z",
    "teamId": "5f36a6e9801571f7ed7476b8",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-08-14T14:59:56.167Z",
    "syncs": 1,
    "title": "Senior Web Developer #25",
    "labels": null,
    "state": "published",
    "enforcedTimeLimit": null,
    "suggestedEstimatedTime": 6,
    "manualEstimatedTime": null,
    "passingScore": 100,
    "demoData": false,
    "assessmentUpdatedAt": "2020-08-14T14:59:53.396Z",
    "challengesCount": 3,
    "solutionsCount": 21,
    "counts": {
      "total": 7,
      "abandoned": 0,
      "passed": 0,
      "states": {
        "started": 5,
        "submitted": 2
      },
      "closed_reasons": {
        "candidate_submitted": 2
      }
    },
    "assessmentInvitationCounts": {},
    "solutionRisks": {},
    "submissionRate": 28.57142857142857,
    "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
        },
        "outliers": [],
        "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
        },
        "outliers": [],
        "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
        },
        "outliers": [],
        "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
        }
      }
    },
    "publishedAt": "2020-08-14T14:59:53.358Z",
    "challengeStats": [
      {
        "id": "5f36a6e9801571f7ed7476c0",
        "position": 1,
        "title": "Sequence Monad #41",
        "type": "CodeChallenge",
        "difficulty": 1,
        "disabledLanguages": null,
        "totalCount": 7,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      },
      {
        "id": "5f36a6e9801571f7ed7476c4",
        "position": 2,
        "title": "Custom Objects #42",
        "type": "CodeChallenge",
        "difficulty": 1,
        "disabledLanguages": null,
        "totalCount": 7,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      },
      {
        "id": "5f36a6e9801571f7ed7476c8",
        "position": 3,
        "title": "Binding Sequence #43",
        "type": "CodeChallenge",
        "difficulty": 1,
        "disabledLanguages": null,
        "totalCount": 7,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 7,
              "min": 7,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 7,
              "uFence": 0,
              "uOutliers": 0,
              "max": 7
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2020-08-14T10:59:55.194-04: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/5f36a6eb801571f7ed747715/challenge_items/

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmViODAxNTcxZjdlZDc0NzcxNiIsImlkIjoiNWYzNmE2ZWI4MDE1NzFmN2VkNzQ3NzE3Iiwic2VjcmV0IjoiTk5QTWFBPT0ifQ.d8_0asuDCOB6AYxVJ20EDf6_9_Tbx39wVwYNPgEopAQ

Body

{
  "data": {
    "challenge_id": "5f36a6eb801571f7ed747719"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6eb801571f7ed74771f",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5f36a6eb801571f7ed74771f",
    "challengeId": "5f36a6eb801571f7ed747719",
    "position": 1,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-08-14T10:59:55.445-04: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/5f36a6eb801571f7ed747728/challenge_items/5f36a6eb801571f7ed74772f

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmViODAxNTcxZjdlZDc0NzcyOSIsImlkIjoiNWYzNmE2ZWI4MDE1NzFmN2VkNzQ3NzJhIiwic2VjcmV0IjoidFhaR3RRPT0ifQ.5gF__vAJ8EnVNSRE2OVSD1GCW_RgnnToPQXNXVLCaj4

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6eb801571f7ed74772f",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5f36a6eb801571f7ed74772f",
    "challengeId": "5f36a6eb801571f7ed74772c",
    "position": 2,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-08-14T10:59:55.742-04: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/5f36a6eb801571f7ed74773c/challenge_items/5f36a6eb801571f7ed747743

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmViODAxNTcxZjdlZDc0NzczZCIsImlkIjoiNWYzNmE2ZWI4MDE1NzFmN2VkNzQ3NzNlIiwic2VjcmV0IjoiM1huV3ZnPT0ifQ.j_zTuWeUg75m3KLmddOCHOoMJLXN5bAedLoRtt6JD8c
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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmVjODAxNTcxZjdlZDc0Nzc0YyIsImlkIjoiNWYzNmE2ZWM4MDE1NzFmN2VkNzQ3NzRkIiwic2VjcmV0IjoiU1RNSm9nPT0ifQ.w-XaB2-hGUwyZCYnJ_AacEApzkESVp6KeuYxGNepMSg

Query Parameters

{}=

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5f36a6ec801571f7ed747761",
      "state": "active",
      "teamCandidateId": "5f36a6ec801571f7ed747769",
      "assessmentId": "5f36a6ec801571f7ed747762",
      "assessmentResultId": "5f36a6ec801571f7ed74776d",
      "teamId": "5f36a6ec801571f7ed747746",
      "teamMemberId": "5f36a6ec801571f7ed74776b",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-08-14T14:59:56.429Z",
      "invitePath": "/assess/5f36a6ec801571f7ed747762?activate=ysBuFFXVb3crpw.5f36a6ec801571f7ed747768&email=loginidentity101%40example.com&invite=zLdafRjnTQx9dA",
      "invitePracticePath": "/assess/practice-cc?activate=ysBuFFXVb3crpw.5f36a6ec801571f7ed747768&email=loginidentity101%40example.com&invite=zLdafRjnTQx9dA&returnTo=%2Fassess%2F5f36a6ec801571f7ed747762%3Factivate%3DysBuFFXVb3crpw.5f36a6ec801571f7ed747768%26email%3Dloginidentity101%2540example.com%26invite%3DzLdafRjnTQx9dA",
      "assessmentTitle": "Junior Ruby Engineer #29",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith101",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    },
    {
      "id": "5f36a6ec801571f7ed747771",
      "state": "active",
      "teamCandidateId": "5f36a6ec801571f7ed747779",
      "assessmentId": "5f36a6ec801571f7ed747772",
      "assessmentResultId": "5f36a6ec801571f7ed74777d",
      "teamId": "5f36a6ec801571f7ed747746",
      "teamMemberId": "5f36a6ec801571f7ed74777b",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-08-14T14:59:56.589Z",
      "invitePath": "/assess/5f36a6ec801571f7ed747772?activate=CzDs9UscMpgiXw.5f36a6ec801571f7ed747778&email=loginidentity103%40example.com&invite=PXzxetLDbNjyGw",
      "invitePracticePath": "/assess/practice-cc?activate=CzDs9UscMpgiXw.5f36a6ec801571f7ed747778&email=loginidentity103%40example.com&invite=PXzxetLDbNjyGw&returnTo=%2Fassess%2F5f36a6ec801571f7ed747772%3Factivate%3DCzDs9UscMpgiXw.5f36a6ec801571f7ed747778%26email%3Dloginidentity103%2540example.com%26invite%3DPXzxetLDbNjyGw",
      "assessmentTitle": "Senior Ruby Developer #30",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith103",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    },
    {
      "id": "5f36a6ec801571f7ed747781",
      "state": "active",
      "teamCandidateId": "5f36a6ec801571f7ed747789",
      "assessmentId": "5f36a6ec801571f7ed747782",
      "assessmentResultId": "5f36a6ec801571f7ed74778d",
      "teamId": "5f36a6ec801571f7ed747746",
      "teamMemberId": "5f36a6ec801571f7ed74778b",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-08-14T14:59:56.743Z",
      "invitePath": "/assess/5f36a6ec801571f7ed747782?activate=Fk2F3T2VcpLpiQ.5f36a6ec801571f7ed747788&email=loginidentity105%40example.com&invite=nNHUza3GOrkryA",
      "invitePracticePath": "/assess/practice-cc?activate=Fk2F3T2VcpLpiQ.5f36a6ec801571f7ed747788&email=loginidentity105%40example.com&invite=nNHUza3GOrkryA&returnTo=%2Fassess%2F5f36a6ec801571f7ed747782%3Factivate%3DFk2F3T2VcpLpiQ.5f36a6ec801571f7ed747788%26email%3Dloginidentity105%2540example.com%26invite%3DnNHUza3GOrkryA",
      "assessmentTitle": "Senior Angular Developer #31",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith105",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-08-14T10:59:56.832-04: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[access_locked] 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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmVjODAxNTcxZjdlZDc0Nzc5OSIsImlkIjoiNWYzNmE2ZWM4MDE1NzFmN2VkNzQ3NzlhIiwic2VjcmV0IjoiWDZqdXFnPT0ifQ.lTYA7BGMrnlqf8nlAhXSgL12nt9EnqovVf5tVgpbUyU

Body

{
  "data": {
    "candidates": [
      "[email protected]"
    ],
    "assessment_id": "5f36a6ec801571f7ed74779c",
    "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": "5f36a6ed801571f7ed7477a4",
      "state": "active",
      "teamCandidateId": "5f36a6ed801571f7ed74779f",
      "assessmentId": "5f36a6ec801571f7ed74779c",
      "assessmentResultId": "5f36a6ed801571f7ed7477a0",
      "teamId": "5f36a6ec801571f7ed747793",
      "teamMemberId": "5f36a6ec801571f7ed74779a",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-08-14T14:59:57.193Z",
      "invitePath": "/assess/5f36a6ec801571f7ed74779c?activate=oubv2w9go03RGw.5f36a6ed801571f7ed74779e&email=George%40place.com&invite=prsp6H65psizkw",
      "invitePracticePath": "/assess/practice-?activate=oubv2w9go03RGw.5f36a6ed801571f7ed74779e&email=George%40place.com&invite=prsp6H65psizkw&returnTo=%2Fassess%2F5f36a6ec801571f7ed74779c%3Factivate%3Doubv2w9go03RGw.5f36a6ed801571f7ed74779e%26email%3DGeorge%2540place.com%26invite%3Dprsp6H65psizkw",
      "assessmentTitle": "Mid-Level Full-Stack Developer #32",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "George Smith",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    }
  ],
  "meta": {
    "timestamp": "2020-08-14T10:59:57.234-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmVkODAxNTcxZjdlZDc0NzdjMyIsImlkIjoiNWYzNmE2ZWQ4MDE1NzFmN2VkNzQ3N2M0Iiwic2VjcmV0Ijoib0VHZStRPT0ifQ.vlxzf4-qsAPoq6vPx2xnBypPtWeypEvq2BozYKnwH5o

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5f36a6ed801571f7ed7477d0",
      "state": "active",
      "teamCandidateId": "5f36a6ed801571f7ed7477cb",
      "assessmentId": "5f36a6ed801571f7ed7477c6",
      "assessmentResultId": "5f36a6ed801571f7ed7477cc",
      "teamId": "5f36a6ed801571f7ed7477bd",
      "teamMemberId": "5f36a6ed801571f7ed7477c4",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-08-14T14:59:57.945Z",
      "invitePath": "/assess/5f36a6ed801571f7ed7477c6?activate=Mis3DCXFuVGkGQ.5f36a6ed801571f7ed7477ca&email=George%40place.com&invite=yMc7qB3ZDQkKmg",
      "invitePracticePath": "/assess/practice-?activate=Mis3DCXFuVGkGQ.5f36a6ed801571f7ed7477ca&email=George%40place.com&invite=yMc7qB3ZDQkKmg&returnTo=%2Fassess%2F5f36a6ed801571f7ed7477c6%3Factivate%3DMis3DCXFuVGkGQ.5f36a6ed801571f7ed7477ca%26email%3DGeorge%2540place.com%26invite%3DyMc7qB3ZDQkKmg",
      "assessmentTitle": "Mid-Level Full-Stack Developer #34",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": true,
      "inviterRole": "owner"
    }
  ],
  "meta": {
    "timestamp": "2020-08-14T10:59:57.964-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmVmODAxNTcxZjdlZDc0Nzg0MSIsImlkIjoiNWYzNmE2ZWY4MDE1NzFmN2VkNzQ3ODQyIiwic2VjcmV0IjoiQXlhQ1N3PT0ifQ.C0P3FwiR0G57DK6PUUVQ5eKD8Q_4QZUgFQIDvgyl9bA

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResultReview",
  "data": [
    {
      "id": "5f36a6ef801571f7ed74783d",
      "reviewedById": "5f36a6ef801571f7ed74783f",
      "reviewedByStaff": null,
      "assessmentId": "5f36a6ef801571f7ed74782e",
      "assessmentResultId": "5f36a6ef801571f7ed747836",
      "teamCandidateId": "5f36a6ef801571f7ed747839",
      "candidateId": "5f36a6ef801571f7ed747838",
      "rating": 5,
      "feedback": "great!",
      "state": "started",
      "createdAt": "2020-08-14T14:59:59.290Z",
      "updatedAt": "2020-08-14T14:59:59.290Z",
      "ratingLabel": "Approve",
      "ratingScore": 1.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T10:59:59.360-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_result_reviews/:id

Request

Route

GET /v1/assessment_result_reviews/5f36a6ef801571f7ed74785e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmVmODAxNTcxZjdlZDc0Nzg1YiIsImlkIjoiNWYzNmE2ZWY4MDE1NzFmN2VkNzQ3ODVjIiwic2VjcmV0IjoiTU5XVE93PT0ifQ.bvyifdn-ZJNl3vgSbCReCoEf0iw5BHFwG_MSHsQQfIc

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6ef801571f7ed74785e",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5f36a6ef801571f7ed74785e",
    "reviewedById": "5f36a6ef801571f7ed747860",
    "reviewedByStaff": null,
    "assessmentId": "5f36a6ef801571f7ed74784c",
    "assessmentResultId": "5f36a6ef801571f7ed747854",
    "teamCandidateId": "5f36a6ef801571f7ed747857",
    "candidateId": "5f36a6ef801571f7ed747856",
    "rating": 5,
    "feedback": "great!",
    "state": "started",
    "createdAt": "2020-08-14T14:59:59.695Z",
    "updatedAt": "2020-08-14T14:59:59.695Z",
    "ratingLabel": "Approve",
    "ratingScore": 1.0
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-08-14T10:59:59.726-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYwODAxNTcxZjdlZDc0Nzg3OSIsImlkIjoiNWYzNmE2ZjA4MDE1NzFmN2VkNzQ3ODdhIiwic2VjcmV0IjoiRDBnNVd3PT0ifQ.C-dXApqqLS8EQnP6DUn3iXjGgz3XmEq0jbDl9VTmYgM

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f0801571f7ed74787c",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5f36a6f0801571f7ed74787c",
    "reviewedById": "5f36a6f0801571f7ed74787a",
    "reviewedByStaff": false,
    "assessmentId": "5f36a6ef801571f7ed74786a",
    "assessmentResultId": "5f36a6ef801571f7ed747872",
    "teamCandidateId": "5f36a6ef801571f7ed747875",
    "candidateId": "5f36a6ef801571f7ed747874",
    "rating": null,
    "feedback": "super duper",
    "state": "started",
    "createdAt": "2020-08-14T15:00:00.105Z",
    "updatedAt": "2020-08-14T15:00:00.105Z",
    "ratingLabel": null,
    "ratingScore": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-08-14T11:00:00.119-04: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/5f36a6f0801571f7ed747897

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYwODAxNTcxZjdlZDc0Nzg5NCIsImlkIjoiNWYzNmE2ZjA4MDE1NzFmN2VkNzQ3ODk1Iiwic2VjcmV0IjoiSTZUZEF3PT0ifQ.Gs4HbpCcTDEyekK9RvM_9zQKOTinsIVkfEP34Y9AMmA

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f0801571f7ed747897",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5f36a6f0801571f7ed747897",
    "reviewedById": "5f36a6f0801571f7ed747899",
    "reviewedByStaff": false,
    "assessmentId": "5f36a6f0801571f7ed747885",
    "assessmentResultId": "5f36a6f0801571f7ed74788d",
    "teamCandidateId": "5f36a6f0801571f7ed747890",
    "candidateId": "5f36a6f0801571f7ed74788f",
    "rating": 3,
    "feedback": "feedback",
    "state": "started",
    "createdAt": "2020-08-14T15:00:00.514Z",
    "updatedAt": "2020-08-14T15:00:00.566Z",
    "ratingLabel": "Neutral",
    "ratingScore": 0.5
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-08-14T11:00:00.577-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessment_result_reviews/:id

Request

Route

DELETE /v1/assessment_result_reviews/5f36a6f0801571f7ed7478b5

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYwODAxNTcxZjdlZDc0NzhiMiIsImlkIjoiNWYzNmE2ZjA4MDE1NzFmN2VkNzQ3OGIzIiwic2VjcmV0IjoiRnJBTS93PT0ifQ.ZmTM9YswGf68Zom8x8Qy3O_fsujZ-nuLBUQl_FXirw8
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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYxODAxNTcxZjdlZDc0NzhlMyIsImlkIjoiNWYzNmE2ZjE4MDE1NzFmN2VkNzQ3OGU0Iiwic2VjcmV0IjoiemNaK2F3PT0ifQ.jVSVSxpQEtEnurAbcRDk7S8nVYHu34mNrIt-rbaVxyY

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResult",
  "data": [
    {
      "id": "5f36a6f1801571f7ed7478dd",
      "assessmentId": "5f36a6f1801571f7ed7478d8",
      "candidateId": "5f36a6f1801571f7ed7478ba",
      "teamCandidateId": "5f36a6f1801571f7ed7478de",
      "teamId": "5f36a6f1801571f7ed7478bd",
      "state": "started",
      "createdAt": "2020-08-14T15:00:01.402Z",
      "updatedAt": "2020-08-14T15:00:01.402Z",
      "startedAt": "2020-08-14T15:00:01.402Z",
      "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,
      "stateUpdatedAt": "2020-08-14T15:00:01.402Z",
      "totalSubmissionSeconds": null,
      "totalOriginalSubmissionSeconds": null,
      "accumulatedSeconds": 0,
      "enforcedTimeLimit": null,
      "timerExpiresIn": null,
      "wallTimeSinceStart": 0,
      "reopenedById": null,
      "activeTimedSolutionId": null,
      "accessLocked": false,
      "accessUnlockedAt": null,
      "accessUnlockedById": null,
      "terminatedAt": null,
      "isActiveInteractSession": false,
      "candidateName": "Joe Smith141",
      "candidateEmail": "[email protected]",
      "candidatePhone": null,
      "interviewerIds": [],
      "activeInterviewerIds": [],
      "abandoned": false,
      "workflowName": null,
      "isInteractSession": false,
      "passingScore": false,
      "challengeItems": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:00:01.515-04: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/5f36a6f2801571f7ed747938

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYyODAxNTcxZjdlZDc0NzkxNCIsImlkIjoiNWYzNmE2ZjI4MDE1NzFmN2VkNzQ3OTE1Iiwic2VjcmV0IjoibUg1S3N3PT0ifQ.xMo9ZZVBcGsBMqYkNkr0U_mrTV7Jwbrk6yWAR-qAQSE

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f2801571f7ed747938",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f2801571f7ed747938",
    "assessmentId": "5f36a6f2801571f7ed747933",
    "candidateId": "5f36a6f2801571f7ed747915",
    "teamCandidateId": "5f36a6f2801571f7ed747939",
    "teamId": "5f36a6f2801571f7ed747918",
    "state": "started",
    "createdAt": "2020-08-14T15:00:02.565Z",
    "updatedAt": "2020-08-14T15:00:02.565Z",
    "startedAt": "2020-08-14T15:00:02.565Z",
    "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,
    "stateUpdatedAt": "2020-08-14T15:00:02.565Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith159",
    "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-08-14T11:00:02.662-04:00",
    "includes": []
  }
}

Share

Returns a set of sharable URLs which do not require login, only available if option is enabled on your subscription

Endpoint

GET /v1/assessment_results/:id/share

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5f36a6f4801571f7ed7479b8/share

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmYzODAxNTcxZjdlZDc0Nzk5NCIsImlkIjoiNWYzNmE2ZjM4MDE1NzFmN2VkNzQ3OTk1Iiwic2VjcmV0IjoiWUpud2ZRPT0ifQ.0QemLcvALmW2vO7KknL3Q0CzD7udOX4ZdHV58lLznTM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f4801571f7ed7479b8",
  "url": "https://home.overzealous.com:3001/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWI4Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZjM2YTZmMzgwMTU3MWY3ZWQ3NDc5OTgifQ.ar2oKN6yTR5vr5P8UhyldbS3S6es1i_MUsJ6mPM8X54/assessment_result",
  "pdf": "https://home.overzealous.com:3001/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWI4Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZjM2YTZmMzgwMTU3MWY3ZWQ3NDc5OTgifQ.ar2oKN6yTR5vr5P8UhyldbS3S6es1i_MUsJ6mPM8X54/assessment_result",
  "solutions": [
    {
      "id": "5f36a6f4801571f7ed7479bd",
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWJkIiwiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWI0Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZjM2YTZmMzgwMTU3MWY3ZWQ3NDc5OTgifQ.vA7NIeN8d8nWx490Mv0sUxr6wxPpUEXDAbKLmjRnLew",
      "embedUrl": "https://home.overzealous.com:3001/research/embed/solution-review/5f36a6f4801571f7ed7479bd?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWJkIiwiNWYzNmE2ZjQ4MDE1NzFmN2VkNzQ3OWI0Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZjM2YTZmMzgwMTU3MWY3ZWQ3NDc5OTgifQ.vA7NIeN8d8nWx490Mv0sUxr6wxPpUEXDAbKLmjRnLew"
    }
  ]
}

Unlock Access

Unlocks an access_locked assessment result so a candidate can begin their assessment.

Endpoint

PUT /v1/assessment_results/:id/unlock_access

Request

Route

PUT /v1/assessment_results/5f36a6f5801571f7ed747a26/unlock_access

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY1ODAxNTcxZjdlZDc0N2EwYyIsImlkIjoiNWYzNmE2ZjU4MDE1NzFmN2VkNzQ3YTBkIiwic2VjcmV0IjoiZEJIOVRRPT0ifQ.QuIGQHWCxomnKSXgbCeFrp686ze4MwW1wzG1atGurzQ

Body

{}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f5801571f7ed747a26",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f5801571f7ed747a26",
    "assessmentId": "5f36a6f5801571f7ed747a21",
    "candidateId": "5f36a6f5801571f7ed747a03",
    "teamCandidateId": "5f36a6f5801571f7ed747a27",
    "teamId": "5f36a6f5801571f7ed747a06",
    "state": "started",
    "createdAt": "2020-08-14T15:00:05.373Z",
    "updatedAt": "2020-08-14T15:00:05.373Z",
    "startedAt": "2020-08-14T15:00:05.372Z",
    "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,
    "stateUpdatedAt": "2020-08-14T15:00:05.372Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith201",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "passingScore": 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-08-14T11:00:05.468-04:00",
    "includes": []
  }
}

Submit

Submits an assessment to be reviewed/screened by the company/team. This prevents the candidate from continuing, and generates a score, and calls webhooks. Some automated workflows may be triggered, but client-side ones (such as show a message, URL redirects) will not work.

Endpoint

PUT /v1/assessment_results/:id/submit

Request

Route

PUT /v1/assessment_results/5f36a6f6801571f7ed747a7a/submit

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY2ODAxNTcxZjdlZDc0N2E2MCIsImlkIjoiNWYzNmE2ZjY4MDE1NzFmN2VkNzQ3YTYxIiwic2VjcmV0IjoiSWs3dGxBPT0ifQ.UfaeTsSay7dbmb23RumAaXyovgP9vpsBaSRnvwDWjr4

Body

{}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f6801571f7ed747a7a",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f6801571f7ed747a7a",
    "assessmentId": "5f36a6f6801571f7ed747a75",
    "candidateId": "5f36a6f6801571f7ed747a57",
    "teamCandidateId": "5f36a6f6801571f7ed747a7b",
    "teamId": "5f36a6f6801571f7ed747a5a",
    "state": "submitting",
    "createdAt": "2020-08-14T15:00:06.378Z",
    "updatedAt": "2020-08-14T15:00:06.478Z",
    "startedAt": "2020-08-14T15:00:06.378Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "2020-08-14T15:00:06.475Z",
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": "team_forced",
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-08-14T15:00:06.475Z",
    "totalSubmissionSeconds": 0.097292,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith217",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "passingScore": 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-08-14T11:00:06.796-04:00",
    "includes": []
  }
}

Terminate

Closes without submitting the assessment result. This prevents the candidate from continuing, and also doesn't generate a score, call webhooks, or trigger automated workflows.

Endpoint

PUT /v1/assessment_results/:id/terminate

Parameters

Name Description
closed_reason Optional, one of candidate_submitted, timer_ran_out, team_forced, team_decided, invitation_canceled, assessment_archived

Request

Route

PUT /v1/assessment_results/5f36a6f7801571f7ed747aa6/terminate

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY2ODAxNTcxZjdlZDc0N2E4YyIsImlkIjoiNWYzNmE2ZjY4MDE1NzFmN2VkNzQ3YThkIiwic2VjcmV0IjoibXlOZzhBPT0ifQ.2-mEjxo7qw9NpCMKQoCjCBjoxD7Otbrc3dz_WSTqo64

Body

{}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f7801571f7ed747aa6",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f7801571f7ed747aa6",
    "assessmentId": "5f36a6f7801571f7ed747aa1",
    "candidateId": "5f36a6f6801571f7ed747a83",
    "teamCandidateId": "5f36a6f7801571f7ed747aa7",
    "teamId": "5f36a6f6801571f7ed747a86",
    "state": "terminated",
    "createdAt": "2020-08-14T15:00:07.179Z",
    "updatedAt": "2020-08-14T15:00:07.276Z",
    "startedAt": "2020-08-14T15:00:07.179Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": null,
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": null,
    "closedReason": "team_forced",
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-08-14T15:00:07.276Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": "2020-08-14T15:00:07.276Z",
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith225",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "passingScore": 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-08-14T11:00:07.305-04:00",
    "includes": []
  }
}

Unsubmit

Reopens the assessment result so that the candidate can make changes

Endpoint

PUT /v1/assessment_results/:id/unsubmit

Request

Route

PUT /v1/assessment_results/5f36a6f8801571f7ed747afa/unsubmit

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY4ODAxNTcxZjdlZDc0N2FlMCIsImlkIjoiNWYzNmE2Zjg4MDE1NzFmN2VkNzQ3YWUxIiwic2VjcmV0IjoiaVFuL3VRPT0ifQ.nUq9sRN3jBA0QiQX5fib98fEQ3K4aBCjbeFYP8SSEEA
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f8801571f7ed747afa",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f8801571f7ed747afa",
    "assessmentId": "5f36a6f8801571f7ed747af5",
    "candidateId": "5f36a6f7801571f7ed747ad7",
    "teamCandidateId": "5f36a6f8801571f7ed747afb",
    "teamId": "5f36a6f7801571f7ed747ada",
    "state": "opened",
    "createdAt": "1970-01-01T03:26:00.281Z",
    "updatedAt": "2020-08-14T15:00:08.364Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T01:18:00.281Z",
    "openedAt": "2020-08-14T15:00:08.363Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2020-08-14T15:00:08.287Z",
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-08-14T15:00:08.363Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": "5f36a6f8801571f7ed747ae1",
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith241",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "passingScore": 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-08-14T11:00:08.395-04:00",
    "includes": []
  }
}

Reset

Reopens an assessment result, and updates the challenges to the latest published version of the assessment.

Endpoint

PUT /v1/assessment_results/:id/reset

Parameters

Name Description
reset_all If true, completely remove all solutions and start from scratch. Otherwise, only update the assessment result and challenges list.

Request

Route

PUT /v1/assessment_results/5f36a6f8801571f7ed747b23/reset

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY4ODAxNTcxZjdlZDc0N2IwOSIsImlkIjoiNWYzNmE2Zjg4MDE1NzFmN2VkNzQ3YjBhIiwic2VjcmV0IjoiRU1rNjdRPT0ifQ.22HG3RJtSvdcrP0ZGjdxQI2MrNY6XE8qm48vGyhYKyQ

Body

{
  "data": {
    "reset_all": true
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6f8801571f7ed747b23",
  "type": "AssessmentResult",
  "data": {
    "id": "5f36a6f8801571f7ed747b23",
    "assessmentId": "5f36a6f8801571f7ed747b1e",
    "candidateId": "5f36a6f8801571f7ed747b00",
    "teamCandidateId": "5f36a6f8801571f7ed747b24",
    "teamId": "5f36a6f8801571f7ed747b03",
    "state": "opened",
    "createdAt": "1970-01-01T02:40:00.775Z",
    "updatedAt": "2020-08-14T15:00:08.877Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T01:40:00.775Z",
    "openedAt": "2020-08-14T15:00:08.876Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2020-08-14T15:00:08.782Z",
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-08-14T15:00:08.876Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": "5f36a6f8801571f7ed747b0a",
    "activeTimedSolutionId": null,
    "accessLocked": false,
    "accessUnlockedAt": null,
    "accessUnlockedById": null,
    "terminatedAt": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith249",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "passingScore": false,
    "challengeItems": [
      {
        "id": "5f36a6f8801571f7ed747b28",
        "challengeId": "5f36a6f8801571f7ed747b1f",
        "position": 1,
        "disabledLanguages": []
      }
    ]
  },
  "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-08-14T11:00:08.907-04:00",
    "includes": []
  }
}

Destroy

Enables completely destroying an assessment result that has not been started. NOTE: AssessmentResult state MUST be :invited or :opened to be destroyed.

Endpoint

DELETE /v1/assessment_results/:id

Request

Route

DELETE /v1/assessment_results/5f36a6f9801571f7ed747b4d

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmY5ODAxNTcxZjdlZDc0N2IzMyIsImlkIjoiNWYzNmE2Zjk4MDE1NzFmN2VkNzQ3YjM0Iiwic2VjcmV0IjoiVW1hMjRRPT0ifQ.HjsrxFfuabWWsZQ-A9caDvgDNEB_v8Lbh776hCYxKTg

Body

{}

Response

Simulated Response

Status

204

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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZhODAxNTcxZjdlZDc0N2JhNiIsImlkIjoiNWYzNmE2ZmE4MDE1NzFmN2VkNzQ3YmE3Iiwic2VjcmV0IjoiNkN3M2xnPT0ifQ.UzCPylJao6ekQHSSj00fedpiT8HCRwUP-655Ezkxw8s

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5f36a6f9801571f7ed747b5a",
      "title": "Junior Full-Stack Engineer #58",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6f9801571f7ed747b54",
      "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": "Assumenda laborum praesentium. Voluptatem unde est sequi. Enim quod dolore est qui.",
      "challengeItems": [
        {
          "id": "5f36a6f9801571f7ed747b61",
          "challengeId": "5f36a6f9801571f7ed747b5e",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b5e",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Node Parser #73",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.523Z",
            "createdAt": "2020-08-14T15:00:09.533Z",
            "updatedAt": "2020-08-14T15:00:09.533Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b5f",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b60",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "lm1YvUDt5hxwyRE4ysOSNc7dxVmyTs32xrU8sAT9JIHg1O2XdsE1RsUn1OHt\n1IkIHO0EXokjcJaqdBraiQ4ZW2rLGnH6szw8oAsK/Wd4SIkTiRWDFDLmZt4c\nuIOPM4LQ+qEkgJ6Vb+Am0QaJW43JSozEFWkH/vZFhNT5f3HtdVhGxF0Aondc\neL7IVZLS3Bn1\n--4TRO2JUoxof3VadBN+Jx0g==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b65",
          "challengeId": "5f36a6f9801571f7ed747b62",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b62",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Repeated Generator #74",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.578Z",
            "createdAt": "2020-08-14T15:00:09.583Z",
            "updatedAt": "2020-08-14T15:00:09.583Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b63",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b64",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "6yRgRu3IOTpU0E0iigLJaBUtoA0QbXCTdgjW55P08xLTudgi2P2eguONVNAF\nCGQ7/sBqgTP/eIt76geCDMubKV5zqt+qVZ0bbu9Bod5yAEx2aYnb+t/2Ljl4\nAXayZ7Xe89YL5Cf3tTioFEtlk8slraAi/iZQ20fsh8/wWTXHUa5nQkgBq4d1\nKi1X787q/kW7\n--VGS9Tca0A5kn0UAj6wYVCg==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b69",
          "challengeId": "5f36a6f9801571f7ed747b66",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b66",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Date Array #75",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.604Z",
            "createdAt": "2020-08-14T15:00:09.609Z",
            "updatedAt": "2020-08-14T15:00:09.609Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b67",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b68",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "nQ6WaH4bHEykLwD0ySs1R0u08tgDteegbLr6XtIUGGEWgFG/sWO8kNj6hTRf\n1a1bxuMtzNHB0IFH8F1p+ZeZkGdR7tDL8M0LFJId6N4T8yHwl5MymDtfFqnn\nPFYYa4oLWnE6jKOrIsDIsMKntCK10zIgQ5dw+OqIAH6QoUWoaA5FOV0uyPz9\ngtNDURMK3job\n--iOHYh132KTdSDmmGhcp+Pg==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Sed tenetur vero dignissimos. Accusamus non et soluta. Aut totam voluptatibus error.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5f36a6f9801571f7ed747b6a",
      "title": "Senior Front-End Developer #59",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6f9801571f7ed747b54",
      "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": "Amet officia esse quae molestias ea hic voluptas. Molestiae necessitatibus fuga possimus placeat voluptas expedita. Veniam architecto illum tenetur nisi placeat.",
      "challengeItems": [
        {
          "id": "5f36a6f9801571f7ed747b6e",
          "challengeId": "5f36a6f9801571f7ed747b6b",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b6b",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Recursive Objects #76",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.639Z",
            "createdAt": "2020-08-14T15:00:09.644Z",
            "updatedAt": "2020-08-14T15:00:09.644Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b6c",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b6d",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "NoUfTdWkDm9mmkNZfSWuyQrJiqlzbXf8/T8VU1FkEVvmgRxGqMBe8I5lEYHs\njDgMeOXjg3ggiAUZvYIew1E9AFkjbFTJRGZ065TSmYsYYp8cM4qVB8M4FWBa\nFXgLwiuEr8zmepqtdwOTbjImVlKK4bOoM54fN+259/bmXol2SZHqOPcec/Gs\noqH9fcoFsgWO\n--GYWAqBAnjwcLP689MSBWvQ==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b72",
          "challengeId": "5f36a6f9801571f7ed747b6f",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b6f",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Magic Helper #77",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.670Z",
            "createdAt": "2020-08-14T15:00:09.675Z",
            "updatedAt": "2020-08-14T15:00:09.675Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b70",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b71",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "5wL3PWPNL6o5ixPls3hc7MKka4/7vYr30Uru5OYwNxqn7ogvy4mAnNxMaVPx\nRjMgvUd6gj2/JmpxIC8DRqVNgsZNyK6m45/mBZDLT4OfxqNyq1heypUBpdwD\nEC9MZYCmmf6B3floRcq8jyJxeUs7g2CFRtaPdIk96LjQlFgpt+sPNKD+xrOs\n+cLBYyy37OYl\n--bfbIy8u4Cex2hr24vZ9dIQ==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b76",
          "challengeId": "5f36a6f9801571f7ed747b73",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b73",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Actor Encoding #78",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.693Z",
            "createdAt": "2020-08-14T15:00:09.699Z",
            "updatedAt": "2020-08-14T15:00:09.699Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b74",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b75",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "XDEeS0pnXLkCVtFmou8EzDN1NHrPOkGNFhJCj+UQAQ19FeC8545ImfYrFRsZ\ntHHQBIABnV/XdoZI9bUscQawdHl977TG0uyPpE4FEo0uZifgtglIY06kzVRs\nGygUZZYxUel/uWrLCTKcEMgjfmzXd8ulIlOAyg4hJPLZ8V644ReXUamMmDvf\nXW1NYAYCSAZh\n--+qqxgqdrOzV6EjRFaW5RmA==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Maiores odio eos vero voluptatem nihil cum ab. Voluptatem distinctio accusamus aut enim. Cupiditate expedita ut distinctio ipsam omnis sunt.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5f36a6f9801571f7ed747b77",
      "title": "Senior Node Engineer #60",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6f9801571f7ed747b54",
      "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": "Vitae quis excepturi iure saepe occaecati rem consequatur. Illum provident occaecati quam fugit perferendis eos quod. Possimus voluptates similique consequuntur fugiat fuga sed in.",
      "challengeItems": [
        {
          "id": "5f36a6f9801571f7ed747b7b",
          "challengeId": "5f36a6f9801571f7ed747b78",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b78",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Chain Numbers #79",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.726Z",
            "createdAt": "2020-08-14T15:00:09.732Z",
            "updatedAt": "2020-08-14T15:00:09.732Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b79",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b7a",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "+QX5ydrvJ7RKqDZU6XlKjirGzb9irKhK2nrBr94arxdb9Qh0m246VmOJ82Xy\n/9ZN044ZC12kUHEN28Y1TVgRXKJkAKYVydym1Z4zRVakNz+/03YlPHv9vJyH\nvs6QG3T8g0r5M3MwzL1AVP+LfmwgGbSx4rHjt7WYU2uIKPIIegHjC6C1zKDQ\nAuExnV7eULJv\n--7IIg0TSZLLXvsK33UkfonA==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b7f",
          "challengeId": "5f36a6f9801571f7ed747b7c",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b7c",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Repeated Class #80",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.756Z",
            "createdAt": "2020-08-14T15:00:09.761Z",
            "updatedAt": "2020-08-14T15:00:09.761Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b7d",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b7e",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "yhUvj8S81t8Nd7HuG6yAbKuXbsN38YdvmY/sYwZWUFhtaOgD+Jj4vvbomZGQ\nAAMor+qRCTPnI002hDmRtaRaY2gF5Z+ALPK+gM75IbLhCLJYjE4wXZgZi3z/\nnad6caLPdcWlD99hTK8E5YpNJ78R7sDltk9nEnmWmwxM5kbJGUqibQK9DgPe\ntWHApWkO3YtD\n--xsPnlVw86Qi4g0iftHb4oA==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b83",
          "challengeId": "5f36a6f9801571f7ed747b80",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b80",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Travel Algorithm #81",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.779Z",
            "createdAt": "2020-08-14T15:00:09.785Z",
            "updatedAt": "2020-08-14T15:00:09.785Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b81",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b82",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "Itq33XH0ygEK0fzFvMwfxI0nnWMzxnhm+EMS6kXpOQtxnKj6QkbCU7beS1C+\nw72Wv7THnwGLLq0olCccjbopfjghAuptvM0V7A6TmNBmTuRH3T8O9atgNzSW\nIXbALw8qVjJYN6SauSqC5P2Qnp2rBujj8+BKVAa/4/q4ALEJA1XRmT2gnLO6\nACyVuLFQZcjI\n--t/hZVsP/JlQeF3pngjEuyQ==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Sunt velit reiciendis officia corporis sunt. Qui voluptatem tempore voluptas quam. Error id totam debitis voluptates et ex sequi. Voluptatem asperiores sint quam aut veniam modi totam. Fugit ad aut placeat.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5f36a6f9801571f7ed747b84",
      "title": "Junior Back-End Engineer #61",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6f9801571f7ed747b54",
      "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 ipsa ducimus consectetur labore in. Qui culpa sed possimus modi eos enim. Illo maxime expedita ab tenetur.",
      "challengeItems": [
        {
          "id": "5f36a6f9801571f7ed747b88",
          "challengeId": "5f36a6f9801571f7ed747b85",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b85",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Magic Search #82",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.813Z",
            "createdAt": "2020-08-14T15:00:09.818Z",
            "updatedAt": "2020-08-14T15:00:09.818Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b86",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b87",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "p3MzkC8/PIUiGccBf9MFhB0rIESjOPQIiUY7BUSN+QSeVd53uEr5+Lo3axME\nIg8Np/XFAgij4w6DPGrW4YwuRcgv9e8dYnMPqQ/P9rXqLt1AGrPCqI1KSkEh\nuWwujjmlrgiI+/9lyB5HUPfInoNvmtqnCMZ0N4+Nknut7I0wquQ7In0yroal\nRNOK02zgENFz\n--X85GLMSTG+JNyyIpia0cpg==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b8c",
          "challengeId": "5f36a6f9801571f7ed747b89",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b89",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Polymorphic Sequence #83",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.841Z",
            "createdAt": "2020-08-14T15:00:09.847Z",
            "updatedAt": "2020-08-14T15:00:09.847Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b8a",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b8b",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "QdxxLiIAK9lXtoDHL2hRwneOr0tcqWipD7eqAJRs/1h805XCkpBmDKr3AKd3\nzv65TY79nf3WuaKiV0+7IxNgvyOz5+2FK0Hy0h8ZyiGMpSItUU2Mbvq3we+H\nvpB48BuVStzpJ8xyg21B2sgQX8X2lrj7xMTpT+LNm1VLVj0kUCzv5exNe9Yk\nS1/UER1gbsyJ\n--vhQH/MpXy10Fos1RM8EHqQ==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b90",
          "challengeId": "5f36a6f9801571f7ed747b8d",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b8d",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Large Process #84",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.864Z",
            "createdAt": "2020-08-14T15:00:09.869Z",
            "updatedAt": "2020-08-14T15:00:09.869Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b8e",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b8f",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "5i1VYCcuQ7rZOA2HArK1Iz+8J29sZPmE8OUHkvy/H7+l0fZzgHOHKVvrMF8d\nkJawQLaqFa62qtAI0yZyhmB5ZaIgIq3jAoqlxUo0WYK6MtIU2tuXAHl0MEY1\niiJX5KjTj0BgfxNDnK3vQxzECVuqUGkySgdOpHaxFZ7cqjBrlp3hqynG5ZEb\noQpz3QinEgB7\n--QV6+zDN2+u41N3XLHMQljQ==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Vel asperiores voluptatem qui distinctio consequatur eos. Neque ad consectetur molestiae quibusdam autem. Dolor provident delectus dignissimos.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5f36a6f9801571f7ed747b91",
      "title": "Mid-Level Django Developer #62",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6f9801571f7ed747b54",
      "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": "Odio voluptatem quia et quos natus. Ea sint nisi vitae quibusdam. Autem vero sit veniam dolorum ipsam amet tempore. Saepe optio explicabo.",
      "challengeItems": [
        {
          "id": "5f36a6f9801571f7ed747b95",
          "challengeId": "5f36a6f9801571f7ed747b92",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b92",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Heavy Items #85",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.896Z",
            "createdAt": "2020-08-14T15:00:09.901Z",
            "updatedAt": "2020-08-14T15:00:09.901Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b93",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b94",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "L02L2AzPRoSQJKZmx8cmnteh0qMsTp3DnP9CoO6Ti+JZxINT/5QYc0tWjyxa\nQO1IfRx4oXK9hBGvf/iqkmrRKVr7JVC0faaxQVUt/8Qzo4e5ed8ct6YAKczO\n7q9lyUdbKqTXeVwoPn9jmKtv3qQT6CYWKHTnUtcOi8SdZGCxYbfMkBKCEKPH\nJVFClnAiv978\n--HXxQMaOnG1fFeXFgxEwM5w==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b99",
          "challengeId": "5f36a6f9801571f7ed747b96",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b96",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Async Process #86",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.927Z",
            "createdAt": "2020-08-14T15:00:09.932Z",
            "updatedAt": "2020-08-14T15:00:09.932Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b97",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b98",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "VOPMaz3774LrypAAv66BZ2al0rLKEgdi30HgVvaRM2ElDWoT1vQHoipuHcnJ\nEngWQOhNbM+Aq0FhWRyu0Ifrl0jTGfUX63ordJmltz6VIkncpw899tt57UKq\nuvQa6juhkw2kAQF7JLdzxU9nofaR6UY0LkhUO5TaqZOMnWVplQAIwBe+IID4\n0/kpQt0WAAFA\n--/UuW0gCBdbKQJuZOivdKBg==--u"
              }
            ]
          }
        },
        {
          "id": "5f36a6f9801571f7ed747b9d",
          "challengeId": "5f36a6f9801571f7ed747b9a",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5f36a6f9801571f7ed747b9a",
            "$type": "CodeChallenge",
            "teamId": "5f36a6f9801571f7ed747b54",
            "createdById": "5f36a6f9801571f7ed747b5c",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Super Objects #87",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-08-14T15:00:09.949Z",
            "createdAt": "2020-08-14T15:00:09.955Z",
            "updatedAt": "2020-08-14T15:00:09.955Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5f36a6f9801571f7ed747b9b",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "signalMappingsId": null,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "sampleTestCasesReadOnly": false,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5f36a6f9801571f7ed747b9c",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "12.x",
                "languageVersionName": "Node 12.x",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "zUUbaoGbLg341gEX3Mn2c3K+X2L/jAlwYc9QNVSyRPmDd61EURqdeUxbP6+K\nx4CIFi0DclhItskqmmBOHl4OPbFZAGvnR2OBN3WVXER0uOsIa68YcQEK0MtV\n+A0R3BZcSpgaVAWrlHe2Vp0sMPYg3MFBBs9BsL84u9uAcuaqPq9Z5+/iogM2\nXuj7Ls5ylxJ2\n--wM/DSlP8uMtiPUB1UkA2zw==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Ex cupiditate repudiandae. Consequatur autem doloremque. Et omnis non et ipsam rerum consequatur sint.",
      "demoLandingOrder": 1000
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2020-08-14T11:00:10.461-04: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/5f36a6fb801571f7ed747c2e/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZjODAxNTcxZjdlZDc0N2M3YSIsImlkIjoiNWYzNmE2ZmM4MDE1NzFmN2VkNzQ3YzdiIiwic2VjcmV0IjoiUm5Sbm93PT0ifQ.QgFSISwwXtOLkvThtJl1okf7V7yiYsjSUoh2PlyDexc
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": "5f36a6fc801571f7ed747c8f",
  "type": "Assessment",
  "data": {
    "id": "5f36a6fc801571f7ed747c8f",
    "title": "Assessment Title",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a6fc801571f7ed747c74",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 6,
    "copiedFromId": "5f36a6fb801571f7ed747c2e",
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Quia non laborum rerum dolor non et et. Nihil laboriosam illo id. Maxime quidem et praesentium et doloribus laudantium iste. Sed iusto aut sint quia distinctio illum fugit.",
    "challengeItems": [
      {
        "id": "5f36a6fc801571f7ed747c9f",
        "challengeId": "5f36a6fc801571f7ed747c91",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5f36a6fc801571f7ed747ca0",
        "challengeId": "5f36a6fc801571f7ed747c96",
        "position": 2,
        "disabledLanguages": []
      },
      {
        "id": "5f36a6fc801571f7ed747ca1",
        "challengeId": "5f36a6fc801571f7ed747c9b",
        "position": 3,
        "disabledLanguages": []
      }
    ],
    "purpose": "Aut est quia neque. Mollitia autem beatae sequi. Aut ipsam earum numquam culpa. Ut rem sunt officia qui nihil cum. Minima necessitatibus reiciendis ut et explicabo repellat non.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-08-14T15:00:12.619Z",
    "archivedAt": null,
    "createdAt": "2020-08-14T15:00:12.615Z",
    "assessmentResultsSummary": {
      "_id": "5f36a6fc801571f7ed747ca3"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a6fc801571f7ed747ca2",
      "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-08-14T11:00:12.651-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZlODAxNTcxZjdlZDc0N2QxMiIsImlkIjoiNWYzNmE2ZmU4MDE1NzFmN2VkNzQ3ZDEzIiwic2VjcmV0Ijoia3hWM2h3PT0ifQ.wcDhAxEUKxAEz-uRu5oh1HhgV3k1gFL-gbPsQPZzaSg

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5f36a6fd801571f7ed747cfd",
      "title": "Senior Node Developer #78",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5f36a6fd801571f7ed747cf7",
      "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": "Corporis dolores sed eos aut enim. Autem amet magnam veniam. Est reiciendis velit quisquam voluptas rem.",
      "challengeItems": [
        {
          "id": "5f36a6fd801571f7ed747d04",
          "challengeId": "5f36a6fd801571f7ed747d01",
          "position": 1,
          "disabledLanguages": []
        }
      ],
      "purpose": "Aliquam corrupti omnis laboriosam aut. Voluptas similique reiciendis veniam aperiam libero. A corrupti aut dolorem perspiciatis ut.",
      "demoLandingOrder": 1000,
      "publishedAt": "2020-08-14T15:00:13.885Z",
      "archivedAt": null,
      "createdAt": "2020-08-14T15:00:13.920Z",
      "assessmentResultsSummary": {
        "_id": "5f36a6fe801571f7ed747d09",
        "all": 2,
        "started": 2
      },
      "labels": null,
      "notificationScheme": null,
      "defaultExpirationDays": null,
      "defaultReminderDays": null,
      "minReviewsBeforeConsideredReviewed": 1,
      "defaultAssignedTeamMemberIds": [],
      "defaultTeamCandidateLabels": null,
      "defaultAccessLocked": null,
      "assignmentTeamMemberIds": [],
      "redirectUrl": null,
      "webhookUrl": null,
      "submissionMessage": null,
      "assignmentLabels": null,
      "assignmentRole": null,
      "workflowPaths": [],
      "bambooConfig": {
        "id": "5f36a6fe801571f7ed747d15",
        "jobId": null,
        "resultStateTriggers": null,
        "candidateStateTriggers": null,
        "sendStatus": null
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:00:14.139-04: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/5f36a6fe801571f7ed747d1e

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6fe801571f7ed747d1e",
  "type": "Assessment",
  "data": {
    "id": "5f36a6fe801571f7ed747d1e",
    "title": "Mid-Level Mobile Engineer #79",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a6fe801571f7ed747d18",
    "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": "Quo sapiente sit. Vero vitae eius repellendus et molestias molestiae. Asperiores et ab accusamus vero aliquam ex facere. Sapiente incidunt asperiores amet quae qui perferendis sit.",
    "challengeItems": [
      {
        "id": "5f36a6fe801571f7ed747d25",
        "challengeId": "5f36a6fe801571f7ed747d22",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "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-08-14T11:00:14.545-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZmODAxNTcxZjdlZDc0N2Q1ZSIsImlkIjoiNWYzNmE2ZmY4MDE1NzFmN2VkNzQ3ZDVmIiwic2VjcmV0IjoiaU92WFVBPT0ifQ.itz1W9MY7THuaji-IxGvC4GMSf6pfFPaw9iLKMJwdpE
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": "5f36a6ff801571f7ed747d72",
  "type": "Assessment",
  "data": {
    "id": "5f36a6ff801571f7ed747d72",
    "title": "Angular Developer",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a6ff801571f7ed747d57",
    "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": [],
    "purpose": null,
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-08-14T15:00:15.373Z",
    "assessmentResultsSummary": {
      "_id": "5f36a6ff801571f7ed747d74"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a6ff801571f7ed747d73",
      "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-08-14T11:00:15.392-04: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/5f36a6ff801571f7ed747d7d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZmODAxNTcxZjdlZDc0N2Q3ZSIsImlkIjoiNWYzNmE2ZmY4MDE1NzFmN2VkNzQ3ZDdmIiwic2VjcmV0IjoiWVgzaThRPT0ifQ.Llx8s_epsrfB7wzQbZYn3WSvHf3-pmJ6RE5Zmivfvdk
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": "5f36a6ff801571f7ed747d7d",
  "type": "Assessment",
  "data": {
    "id": "5f36a6ff801571f7ed747d7d",
    "title": "Senior Node Developer #82",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a6ff801571f7ed747d77",
    "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": "5f36a6ff801571f7ed747d84",
        "challengeId": "5f36a6ff801571f7ed747d81",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Quod consectetur sunt. Sit nam quos. Ut alias illo. Perferendis perspiciatis voluptates laudantium in qui id. Ut possimus molestiae ipsam tempora dignissimos.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-08-14T15:00:15.539Z",
    "archivedAt": null,
    "createdAt": "2020-08-14T15:00:15.579Z",
    "assessmentResultsSummary": {
      "_id": "5f36a6ff801571f7ed747d89",
      "all": 2,
      "started": 2
    },
    "labels": [
      "Test"
    ],
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a6ff801571f7ed747d92",
      "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-08-14T11:00:15.803-04:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/assessments/:id/publish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5f36a6ff801571f7ed747d9b/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNmZmODAxNTcxZjdlZDc0N2Q5YyIsImlkIjoiNWYzNmE2ZmY4MDE1NzFmN2VkNzQ3ZDlkIiwic2VjcmV0IjoiQlRoKzhRPT0ifQ.IHy2P1esU3La59WvbjDahDULtA2r-8826ehmh9KratE
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a6ff801571f7ed747d9b",
  "type": "Assessment",
  "data": {
    "id": "5f36a6ff801571f7ed747d9b",
    "title": "Junior Big-Data Developer #83",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a6ff801571f7ed747d95",
    "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": "Excepturi nisi hic nesciunt eveniet. Consequatur error accusantium ab repellat enim. Molestiae sed et et. Nesciunt velit eius.",
    "challengeItems": [],
    "purpose": "Aut quia quos id totam. Quis quaerat quia est modi. Rerum quam et. Natus perspiciatis quos architecto tempora at sit.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-08-14T15:00:15.995Z",
    "archivedAt": null,
    "createdAt": "2020-08-14T15:00:15.966Z",
    "assessmentResultsSummary": {
      "_id": "5f36a700801571f7ed747da0"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a700801571f7ed747d9f",
      "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-08-14T11:00:16.021-04:00",
    "includes": []
  }
}

Un-publish

Endpoint

PUT /v1/assessments/:id/unpublish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5f36a700801571f7ed747db9/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzAwODAxNTcxZjdlZDc0N2RiYSIsImlkIjoiNWYzNmE3MDA4MDE1NzFmN2VkNzQ3ZGJiIiwic2VjcmV0IjoiWUIrY3l3PT0ifQ.Oxv4x9F9PHNcOo8XnWJrTk-7zTmGlrizLEeHzoBfC_w
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a700801571f7ed747db9",
  "type": "Assessment",
  "data": {
    "id": "5f36a700801571f7ed747db9",
    "title": "Junior Web Developer #85",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a700801571f7ed747db3",
    "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": "Ut cumque voluptatum. Accusantium voluptatem aliquam quos incidunt. Dolorem eligendi iure.",
    "challengeItems": [
      {
        "id": "5f36a700801571f7ed747dc0",
        "challengeId": "5f36a700801571f7ed747dbd",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Cupiditate id magnam sapiente reiciendis esse. Fugiat voluptatibus voluptates harum sequi voluptas eum veritatis. Blanditiis perferendis id qui. Qui dicta autem harum recusandae ipsa dolores dignissimos. Voluptatibus repellat amet eos.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-08-14T15:00:16.402Z",
    "assessmentResultsSummary": {
      "_id": "5f36a700801571f7ed747dc5",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a700801571f7ed747dce",
      "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-08-14T11:00:16.608-04:00",
    "includes": []
  }
}

Archive

Archives the assessment

Endpoint

PUT /v1/assessments/:id/archive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5f36a700801571f7ed747dd7/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzAwODAxNTcxZjdlZDc0N2RkOCIsImlkIjoiNWYzNmE3MDA4MDE1NzFmN2VkNzQ3ZGQ5Iiwic2VjcmV0IjoiMlNaOXVRPT0ifQ.JNsO6WSJOoB7LsbbcpUCZqNzBO4GLSYgP6BwcHMGbWw
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a700801571f7ed747dd7",
  "type": "Assessment",
  "data": {
    "id": "5f36a700801571f7ed747dd7",
    "title": "Junior Mobile Engineer #86",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a700801571f7ed747dd1",
    "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": "Assumenda at inventore quidem omnis iure. Non debitis et blanditiis. Iure sint molestiae. Neque a cumque corrupti distinctio. Veniam quia voluptatem et delectus earum.",
    "challengeItems": [
      {
        "id": "5f36a700801571f7ed747dde",
        "challengeId": "5f36a700801571f7ed747ddb",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Qui eum ut id veritatis nisi. Soluta enim excepturi numquam temporibus molestiae. Nemo veritatis laborum minima ut modi repellendus. Nobis ea quisquam rerum eaque.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-08-14T15:00:16.794Z",
    "archivedAt": "2020-08-14T15:00:17.008Z",
    "createdAt": "2020-08-14T15:00:16.829Z",
    "assessmentResultsSummary": {
      "_id": "5f36a700801571f7ed747de3",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a701801571f7ed747dec",
      "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-08-14T11:00:17.040-04:00",
    "includes": []
  }
}

Unarchive

Unarchives the assessment

Endpoint

PUT /v1/assessments/:id/unarchive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5f36a701801571f7ed747e12/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzAxODAxNTcxZjdlZDc0N2RmNiIsImlkIjoiNWYzNmE3MDE4MDE1NzFmN2VkNzQ3ZGY3Iiwic2VjcmV0Ijoic3dzMkh3PT0ifQ.f1cs4QTkKqYXMMqpgAvj7fH-MzxmUWGBEeorjhhsRK0
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a701801571f7ed747e12",
  "type": "Assessment",
  "data": {
    "id": "5f36a701801571f7ed747e12",
    "title": "Junior Angular Engineer #88",
    "state": "draft",
    "teamId": "5f36a701801571f7ed747e0c",
    "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-08-14T11:00:17.489-04:00",
    "includes": []
  }
}

Recover

Recovers the assessment

Endpoint

PUT /v1/assessments/:id/recover

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5f36a702801571f7ed747e50/recover

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzAxODAxNTcxZjdlZDc0N2UzYyIsImlkIjoiNWYzNmE3MDE4MDE1NzFmN2VkNzQ3ZTNkIiwic2VjcmV0Ijoic2gvR2J3PT0ifQ.0fVSzQX1UnvYukHKjnCwmxOcGZuaokAp5GO1lm_FDFo
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a702801571f7ed747e50",
  "type": "Assessment",
  "data": {
    "id": "5f36a702801571f7ed747e50",
    "title": "Senior Web Developer #91",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5f36a701801571f7ed747e35",
    "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": "Voluptate error eius non. Repellat soluta facilis dicta asperiores modi. Quas enim voluptates iure explicabo exercitationem. Qui omnis blanditiis repellendus qui.",
    "challengeItems": [],
    "purpose": "Deleniti dolores quia beatae. Enim a amet et dolorum et. Sapiente totam ut sit laudantium minus.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": "2020-08-14T15:00:18.228Z",
    "createdAt": "2020-08-14T15:00:18.235Z",
    "assessmentResultsSummary": {
      "_id": "5f36a702801571f7ed747e52"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "defaultAccessLocked": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5f36a702801571f7ed747e51",
      "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-08-14T11:00:18.282-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzRhODAxNTcxZjdlZDc0ODA2NCIsImlkIjoiNWYzNmE3NGE4MDE1NzFmN2VkNzQ4MDY1Iiwic2VjcmV0IjoiMjhSaGZRPT0ifQ.RhGNeRQW9X1ab7qwtl4ijLqlclRJg949C-lrcW3tedo

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "ChallengeBrief",
  "data": [
    {
      "id": "5f36a749801571f7ed748057",
      "createdAt": "2020-08-14T15:01:30.259Z",
      "updatedAt": "2020-08-14T15:01:30.259Z",
      "teamId": "5f36a749801571f7ed74804d",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T15:01:31.259Z",
      "syncs": 1,
      "sourcedFromId": null,
      "signalMappingsId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5f36a749801571f7ed748055",
      "challengeCreatedAt": "2020-08-14T15:01:29.907Z",
      "challengeUpdatedAt": "2020-08-14T15:01:29.907Z",
      "publishedAt": "2020-08-14T15:01:29.901Z",
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "published",
      "title": "Value Handler #130",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "demoData": false,
      "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": 0,
      "labelsCount": 0,
      "tagsCount": 0,
      "submissionRate": 100.0,
      "viableRate": 0.0,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Logic"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "customSignalMappings": null,
      "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,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5f36a749801571f7ed748059",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "12.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:01:30.327-04:00",
    "includes": []
  }
}

List Specific IDs

Endpoint

GET /v1/challenge_briefs

Request

Route

GET /v1/challenge_briefs?where=%7B%22id%22%3A%7B%22in%22%3A%5B%225f36a74a801571f7ed748073%22%2C%225f36a74a801571f7ed748083%22%5D%7D%7D

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzRhODAxNTcxZjdlZDc0ODA4MCIsImlkIjoiNWYzNmE3NGE4MDE1NzFmN2VkNzQ4MDgxIiwic2VjcmV0IjoiREV4RDRBPT0ifQ.7OFR88VFrTz7YCeUiYoPv3EGkuu0OprSQNmjz5vtGUw

Query Parameters

where={"id":{"in":["5f36a74a801571f7ed748073","5f36a74a801571f7ed748083"]}}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "ChallengeBrief",
  "data": [
    {
      "id": "5f36a74a801571f7ed748073",
      "createdAt": "2020-08-14T15:01:30.806Z",
      "updatedAt": "2020-08-14T15:01:30.806Z",
      "teamId": "5f36a74a801571f7ed748069",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T15:01:31.806Z",
      "syncs": 1,
      "sourcedFromId": null,
      "signalMappingsId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5f36a74a801571f7ed748071",
      "challengeCreatedAt": "2020-08-14T15:01:30.490Z",
      "challengeUpdatedAt": "2020-08-14T15:01:30.490Z",
      "publishedAt": "2020-08-14T15:01:30.485Z",
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "published",
      "title": "Email Encoding #131",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "demoData": false,
      "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": 0,
      "labelsCount": 0,
      "tagsCount": 0,
      "submissionRate": 100.0,
      "viableRate": 0.0,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Logic"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "customSignalMappings": null,
      "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,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5f36a74a801571f7ed748075",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "12.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    },
    {
      "id": "5f36a74a801571f7ed748083",
      "createdAt": "2020-08-14T15:01:30.903Z",
      "updatedAt": "2020-08-14T15:01:31.036Z",
      "teamId": "5f36a74a801571f7ed748069",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T15:01:32.035Z",
      "syncs": 1,
      "sourcedFromId": null,
      "signalMappingsId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5f36a74a801571f7ed748085",
      "challengeCreatedAt": "2020-08-14T15:01:30.890Z",
      "challengeUpdatedAt": "2020-08-14T15:01:30.890Z",
      "publishedAt": null,
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "draft",
      "title": "Greedy Solution #132",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "demoData": false,
      "passingScore": 100,
      "revisionsCount": 0,
      "copiesCount": 0,
      "assessmentsCount": 0,
      "reviewsCount": 0,
      "assessmentResultsCount": 0,
      "solutionsCount": 0,
      "submittedSolutionsCount": 0,
      "viableSolutionsCount": null,
      "estimatedTime": 2,
      "timeLimitMin": null,
      "difficulty": 1,
      "languagesCount": 1,
      "topicsCount": 0,
      "labelsCount": 0,
      "tagsCount": 0,
      "submissionRate": null,
      "viableRate": null,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Fundamentals"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "customSignalMappings": null,
      "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": {},
      "filesCount": null,
      "refFilesCount": null,
      "enableExternalIde": null,
      "timeLimitType": null,
      "questionTimeLimitSec": null,
      "questionTimeLimitStartSec": null,
      "questionsCount": null,
      "questionTypes": null,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5f36a74a801571f7ed748088",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "12.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2020-08-14T11:01:31.250-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenge_briefs/:id

Request

Route

GET /v1/challenge_briefs/5f36a74b801571f7ed74809d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzRiODAxNTcxZjdlZDc0ODBhYSIsImlkIjoiNWYzNmE3NGI4MDE1NzFmN2VkNzQ4MGFiIiwic2VjcmV0IjoiV1VJRnNRPT0ifQ.OpyyPCfAxwwsLUhV2WYHAK_T7JAc89PDrJEnaeBsG2g

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a74b801571f7ed74809d",
  "type": "ChallengeBrief",
  "data": {
    "id": "5f36a74b801571f7ed74809d",
    "createdAt": "2020-08-14T15:01:31.810Z",
    "updatedAt": "2020-08-14T15:01:31.810Z",
    "teamId": "5f36a74b801571f7ed748093",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-08-14T15:01:32.810Z",
    "syncs": 1,
    "sourcedFromId": null,
    "signalMappingsId": null,
    "templatedFromId": null,
    "copiedFromId": null,
    "createdById": "5f36a74b801571f7ed74809b",
    "challengeCreatedAt": "2020-08-14T15:01:31.430Z",
    "challengeUpdatedAt": "2020-08-14T15:01:31.430Z",
    "publishedAt": "2020-08-14T15:01:31.424Z",
    "archivedAt": null,
    "type": "CodeChallenge",
    "state": "published",
    "title": "Insane Items #134",
    "summary": null,
    "purpose": null,
    "linkedStatus": "false",
    "copiedFromContentType": null,
    "libraryAccess": null,
    "contentType": "normal",
    "demoData": false,
    "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": 0,
    "labelsCount": 0,
    "tagsCount": 0,
    "submissionRate": 100.0,
    "viableRate": 0.0,
    "passRate": null,
    "inLibrary": false,
    "copiedFromLibrary": null,
    "titleUniqueFromLibrary": null,
    "recruitment": false,
    "education": true,
    "tags": [],
    "topics": [
      "Meta-programming"
    ],
    "labels": [],
    "signalProfilesCount": null,
    "avgSortScore": null,
    "avgKnownScore": null,
    "avgConfidenceScore": null,
    "avgOpinionScore": null,
    "minorOpinionsCount": null,
    "avgKnownObjectivesScore": null,
    "avgKnownQualitiesScore": null,
    "objectivesCount": null,
    "qualitiesCount": null,
    "objectiveCodes": null,
    "qualityCodes": null,
    "subjectCodes": null,
    "customSignalMappings": null,
    "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,
    "baselineStats": {
      "score": null,
      "accumulatedSeconds": null,
      "accumulatedBgSeconds": null,
      "passedAccumulatedSeconds": null,
      "passedAccumulatedBgSeconds": null,
      "revisions": null,
      "mass": null,
      "maxSimilarity": null,
      "ccn": null
    },
    "subjectStats": {
      "score": null,
      "accumulatedSeconds": null,
      "accumulatedBgSeconds": null,
      "passedAccumulatedSeconds": null,
      "passedAccumulatedBgSeconds": null,
      "revisions": null,
      "mass": null,
      "maxSimilarity": null,
      "ccn": null
    },
    "languages": [
      {
        "name": "javascript",
        "Id": "5f36a74b801571f7ed74809f",
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "testFramework": "cw-2",
        "generated": null,
        "languageVersion": "12.x",
        "setupMass": null,
        "modificationMass": null,
        "mass": null,
        "linesAdded": null,
        "linesRemoved": null,
        "setupDifferential": null,
        "comparedAt": null,
        "functions": "",
        "functionsCount": 0,
        "identifiers": "",
        "identifiersCount": 0,
        "clusterCount": 0,
        "solutionsStats": {
          "score": null,
          "accumulatedSeconds": null,
          "accumulatedBgSeconds": null,
          "passedAccumulatedSeconds": null,
          "passedAccumulatedBgSeconds": null,
          "wallTime": null,
          "revisions": null,
          "mass": null,
          "functions": null,
          "ccn": null,
          "avgCcn": null
        }
      }
    ],
    "questions": null
  },
  "meta": {
    "timestamp": "2020-08-14T11:01:31.876-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzRlODAxNTcxZjdlZDc0ODE3ZSIsImlkIjoiNWYzNmE3NGU4MDE1NzFmN2VkNzQ4MTdmIiwic2VjcmV0Ijoib0tVa2F3PT0ifQ.Tpx8e_4xtoHgr2h3kutTX7kVx8pyJTQyJLgbhAezKyw

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeChallenge",
  "data": [
    {
      "id": "5f36a74e801571f7ed74817d",
      "$type": "CodeChallenge",
      "teamId": "5f36a74e801571f7ed748177",
      "createdById": "5f36a74e801571f7ed74817f",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Actor Problem #142",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Meta-programming"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-08-14T15:01:34.299Z",
      "createdAt": "2020-08-14T15:01:34.307Z",
      "updatedAt": "2020-08-14T15:01:34.307Z",
      "libraryAccess": null,
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5f36a74e801571f7ed748181",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "team",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "signalMappingsId": null,
      "galleryImage": null,
      "unitTagMaximums": [],
      "associatedTags": [],
      "embeddable": false,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "sampleTestCasesReadOnly": false,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "yamlConfig": null,
      "languages": [
        {
          "id": "5f36a74e801571f7ed748182",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "12.x",
          "languageVersionName": "Node 12.x",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "preloaded": null,
          "solution": "const add = (a, b) => a + b;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    },
    {
      "id": "5f36a74e801571f7ed74818b",
      "$type": "CodeChallenge",
      "teamId": "5f36a74e801571f7ed748185",
      "createdById": "5f36a74e801571f7ed74818c",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Sequence Encoding #143",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Logic"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-08-14T15:01:34.512Z",
      "createdAt": "2020-08-14T15:01:34.519Z",
      "updatedAt": "2020-08-14T15:01:34.519Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5f36a74e801571f7ed74818f",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": true,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "signalMappingsId": null,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "sampleTestCasesReadOnly": false,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5f36a74e801571f7ed748190",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "12.x",
          "languageVersionName": "Node 12.x",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "Ee6dKwWd27RXYfmox1FzHFi9onSV85QQZ7zuCyICvjBs8JKpZFrg698P8jpb\nR1sBQyOCYVcZnwb1uWk8h7qxyteyWxsBgova2QKtGHq8gP8gyXQN/I9r8D7e\nOHWvm8tiZaIHBlzAUNQwi9Boiw/ZZubGrXIBq4jkPi+koXqjUdzR5MNO2msv\nbigsXmTqnow/\n--DmAsntVjdwg6AOCOwaVrkw==--u"
        }
      ]
    },
    {
      "id": "5f36a74e801571f7ed748194",
      "$type": "CodeChallenge",
      "teamId": "5f36a74e801571f7ed748185",
      "createdById": "5f36a74e801571f7ed74818c",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Fibonacci Methods #145",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": [
        "Templates"
      ],
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-08-14T15:01:34.558Z",
      "createdAt": "2020-08-14T15:01:34.565Z",
      "updatedAt": "2020-08-14T15:01:34.565Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "template",
      "productTypes": {
        "_id": "5f36a74e801571f7ed748195",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "signalMappingsId": null,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "sampleTestCasesReadOnly": false,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5f36a74e801571f7ed748196",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "12.x",
          "languageVersionName": "Node 12.x",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "preloaded": null,
          "solution": "const add = (a, b) => a + b;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-08-14T11:01:34.695-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenges/:id

Parameters

Name Description
id base16 ObjectId

Request

Route

GET /v1/challenges/5f36a750801571f7ed748214

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUwODAxNTcxZjdlZDc0ODIxNSIsImlkIjoiNWYzNmE3NTA4MDE1NzFmN2VkNzQ4MjE2Iiwic2VjcmV0IjoieVdpdFVnPT0ifQ.NgzAWysTraokEF8wWPriqx4GVEr1ZObll0TZEj5M1zo

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a750801571f7ed748214",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a750801571f7ed748214",
    "$type": "CodeChallenge",
    "teamId": "5f36a750801571f7ed74820e",
    "createdById": "5f36a750801571f7ed748216",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Email Sequence #163",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-08-14T15:01:36.731Z",
    "createdAt": "2020-08-14T15:01:36.738Z",
    "updatedAt": "2020-08-14T15:01:36.738Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a750801571f7ed748218",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a750801571f7ed748219",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:36.812-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUwODAxNTcxZjdlZDc0ODIyMyIsImlkIjoiNWYzNmE3NTA4MDE1NzFmN2VkNzQ4MjI0Iiwic2VjcmV0IjoidUZ4eHZRPT0ifQ.9I6sO-N26YAhZkrA2jFFtR3agm2IBaf0ZOYLHsDQgKY

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": "5f36a751801571f7ed748228",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a751801571f7ed748228",
    "$type": "CodeChallenge",
    "teamId": "5f36a750801571f7ed74821c",
    "createdById": "5f36a750801571f7ed748224",
    "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-08-14T15:01:37.062Z",
    "createdAt": "2020-08-14T15:01:37.068Z",
    "updatedAt": "2020-08-14T15:01:37.068Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a750801571f7ed74821f",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": false,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a751801571f7ed748229",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "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-08-14T11:01:37.097-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUxODAxNTcxZjdlZDc0ODIzNCIsImlkIjoiNWYzNmE3NTE4MDE1NzFmN2VkNzQ4MjM1Iiwic2VjcmV0IjoiZHhJcTdnPT0ifQ.37RTErib-edT129MI4uica9BM08Pm_px35QszoK7HDk

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": "5f36a751801571f7ed748240",
  "type": "QuizChallenge",
  "data": {
    "id": "5f36a751801571f7ed748240",
    "$type": "QuizChallenge",
    "teamId": "5f36a751801571f7ed74822d",
    "createdById": "5f36a751801571f7ed748235",
    "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-08-14T15:01:37.309Z",
    "updatedAt": "2020-08-14T15:01:37.309Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a751801571f7ed748230",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "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-08-14T11:01:37.330-04: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/5f36a751801571f7ed74824a

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUxODAxNTcxZjdlZDc0ODI0YiIsImlkIjoiNWYzNmE3NTE4MDE1NzFmN2VkNzQ4MjRjIiwic2VjcmV0IjoiSDkxRmhRPT0ifQ.q0XcY17yH4EosYFsGl6g70K921MCK16UeCzc8YwP41E

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": "5f36a751801571f7ed74824a",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a751801571f7ed74824a",
    "$type": "CodeChallenge",
    "teamId": "5f36a751801571f7ed748244",
    "createdById": "5f36a751801571f7ed74824c",
    "lastUpdatedById": "5f36a751801571f7ed74824c",
    "copiedFromId": null,
    "title": "Sane Lists #166",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Logic"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-08-14T15:01:37.486Z",
    "updatedAt": "2020-08-14T15:01:37.624Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a751801571f7ed74824e",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a751801571f7ed748250",
        "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-08-14T11:01:37.653-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/challenges/:id

Request

Route

DELETE /v1/challenges/5f36a751801571f7ed748259

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUxODAxNTcxZjdlZDc0ODI1YSIsImlkIjoiNWYzNmE3NTE4MDE1NzFmN2VkNzQ4MjViIiwic2VjcmV0IjoiSTNSdkJnPT0ifQ.8cVBmbO77lML6q3IGyQo7GkT83tuqlrBMU-J94QyLIk
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/5f36a752801571f7ed748267/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUyODAxNTcxZjdlZDc0ODI2OCIsImlkIjoiNWYzNmE3NTI4MDE1NzFmN2VkNzQ4MjY5Iiwic2VjcmV0Ijoib0l4WFpRPT0ifQ.1hklE8nejhgMGk-ad5SYsLP6zxi0jtuKXVYD3571L6A
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a752801571f7ed748267",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a752801571f7ed748267",
    "$type": "CodeChallenge",
    "teamId": "5f36a751801571f7ed748261",
    "createdById": "5f36a752801571f7ed748269",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Small Handler #168",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-08-14T15:01:38.066Z",
    "updatedAt": "2020-08-14T15:01:38.128Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a752801571f7ed74826b",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a752801571f7ed74826c",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:38.154-04:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/challenges/:id/publish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5f36a752801571f7ed748275/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUyODAxNTcxZjdlZDc0ODI3NiIsImlkIjoiNWYzNmE3NTI4MDE1NzFmN2VkNzQ4Mjc3Iiwic2VjcmV0IjoiSXdmOHVBPT0ifQ.PSTya_d93lgIVIameIP-KOkaykX_CjdakLRU4Lbrj4o
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a752801571f7ed748275",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a752801571f7ed748275",
    "$type": "CodeChallenge",
    "teamId": "5f36a752801571f7ed74826f",
    "createdById": "5f36a752801571f7ed748277",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Sequence Encoding #169",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-08-14T15:01:38.363Z",
    "createdAt": "2020-08-14T15:01:38.324Z",
    "updatedAt": "2020-08-14T15:01:38.371Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a752801571f7ed748279",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a752801571f7ed74827a",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:38.398-04:00",
    "includes": []
  }
}

Archive

Endpoint

PUT /v1/challenges/:id/archive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5f36a752801571f7ed748283/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUyODAxNTcxZjdlZDc0ODI4NCIsImlkIjoiNWYzNmE3NTI4MDE1NzFmN2VkNzQ4Mjg1Iiwic2VjcmV0IjoieTh1L25nPT0ifQ.rccgHYpT7RANNFQKQ0ji2ExibbdR4AVMQKUKCFJtBhk
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a752801571f7ed748283",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a752801571f7ed748283",
    "$type": "CodeChallenge",
    "teamId": "5f36a752801571f7ed74827d",
    "createdById": "5f36a752801571f7ed748285",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Async Encoding #170",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "archived",
    "publishedAt": "2020-08-14T15:01:38.564Z",
    "createdAt": "2020-08-14T15:01:38.572Z",
    "updatedAt": "2020-08-14T15:01:38.625Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a752801571f7ed748287",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a752801571f7ed748288",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:38.651-04:00",
    "includes": []
  }
}

Un-archive

Endpoint

PUT /v1/challenges/:id/unarchive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5f36a753801571f7ed7482a1/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzUzODAxNTcxZjdlZDc0ODJhMiIsImlkIjoiNWYzNmE3NTM4MDE1NzFmN2VkNzQ4MmEzIiwic2VjcmV0IjoibGlXektRPT0ifQ.7VN6pGfQ14oA4rLQymVRl289KhbdQwR7zm_1mDv_ccU
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a753801571f7ed7482a1",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a753801571f7ed7482a1",
    "$type": "CodeChallenge",
    "teamId": "5f36a752801571f7ed74829b",
    "createdById": "5f36a753801571f7ed7482a3",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Sequential Helper #172",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-08-14T15:01:39.087Z",
    "createdAt": "2020-08-14T15:01:39.052Z",
    "updatedAt": "2020-08-14T15:01:39.094Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a753801571f7ed7482a5",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a753801571f7ed7482a6",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:39.118-04: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/5f36a754801571f7ed74834c/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzU0ODAxNTcxZjdlZDc0ODM0ZCIsImlkIjoiNWYzNmE3NTQ4MDE1NzFmN2VkNzQ4MzRlIiwic2VjcmV0IjoiZVg0dWVBPT0ifQ.uXvi8Hwowrlk-AkK1ga60QOvgcSpRtgNFbhnp2vpD6Q
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a754801571f7ed748353",
  "type": "CodeChallenge",
  "data": {
    "id": "5f36a754801571f7ed748353",
    "$type": "CodeChallenge",
    "teamId": "5f36a754801571f7ed748346",
    "createdById": "5f36a754801571f7ed74834e",
    "lastUpdatedById": null,
    "copiedFromId": "5f36a754801571f7ed74834c",
    "title": "Value Numbers #176 (2020-08-14)",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-08-14T15:01:40.984Z",
    "createdAt": "2020-08-14T15:01:40.919Z",
    "updatedAt": "2020-08-14T15:01:40.919Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": false,
    "copiedFromContentType": "normal",
    "contentType": "normal",
    "productTypes": {
      "_id": "5f36a754801571f7ed748356",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": true,
    "signalMappingsId": null,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "sampleTestCasesReadOnly": false,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5f36a754801571f7ed748355",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "12.x",
        "languageVersionName": "Node 12.x",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "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-08-14T11:01:41.043-04: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=5f36a76a801571f7ed7486c2

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZhODAxNTcxZjdlZDc0ODZjOSIsImlkIjoiNWYzNmE3NmE4MDE1NzFmN2VkNzQ4NmNhIiwic2VjcmV0IjoiQTVPenhnPT0ifQ.VTMbObledbtACt5OgM3D9RAl6-T9vPzhhzEspaDComc

Query Parameters

team_id=5f36a76a801571f7ed7486c2

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "LabelHistory",
  "data": [
    {
      "id": "5f36a76a801571f7ed7486c8",
      "name": "Test",
      "addedAt": "2020-08-14T15:02:02.606Z",
      "removedAt": null,
      "teamId": "5f36a76a801571f7ed7486c2",
      "labeledId": "5f36a76a801571f7ed7486bf",
      "labeledType": "TeamCandidate",
      "addedById": null,
      "removedById": null,
      "labeled": {
        "id": "5f36a76a801571f7ed7486bf",
        "candidateId": "5f36a76a801571f7ed7486be",
        "teamId": "5f36a76a801571f7ed7486c2",
        "state": "invited",
        "demoData": false,
        "prevState": null,
        "assessmentIds": [],
        "assessmentResultIds": [],
        "blinding": "blind_reviewers",
        "createdAt": "2020-08-14T15:02:02.586Z",
        "updatedAt": "2020-08-14T15:02:02.586Z",
        "decidedAt": null,
        "invitedAt": "2020-08-14T15:02:02.586Z",
        "interactSessions": 0,
        "stateUpdatedAt": "2020-08-14T15:02:02.586Z",
        "testTeamMember": false,
        "assignedTeamMemberIds": [],
        "labels": null,
        "archived": false,
        "firstName": "Joe",
        "lastName": "Smith490",
        "anonymousName": "Lime Coyote",
        "email": "[email protected]",
        "name": "Joe Smith490",
        "isBlinded": false,
        "stateLabel": "Invited",
        "stateTransitions": [
          "idle",
          "invited",
          "started",
          "submitted",
          "risk_detected",
          "reviewed",
          "approved",
          "rejected",
          "archived"
        ],
        "risks": null,
        "assessmentsRecap": {
          "id": "5f36a76a801571f7ed7486cc",
          "subjects": []
        }
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:02.690-04: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=5f36a76a801571f7ed7486da

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZhODAxNTcxZjdlZDc0ODZjZCIsImlkIjoiNWYzNmE3NmE4MDE1NzFmN2VkNzQ4NmNlIiwic2VjcmV0IjoibENxR1ZBPT0ifQ.IVVI0n7L1rhgWdf5OyP72xs5M6yWDnw8zwH08g4MDYM

Query Parameters

notable_id=5f36a76a801571f7ed7486da

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Note",
  "data": [
    {
      "id": "5f36a76b801571f7ed7486e7",
      "body": "Illo quae commodi ut ad enim tenetur dolores aspernatur.",
      "userId": "5f36a76a801571f7ed7486df",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5f36a76a801571f7ed7486da"
    },
    {
      "id": "5f36a76b801571f7ed7486e8",
      "body": "Nostrum provident molestiae placeat quia perferendis.",
      "userId": "5f36a76a801571f7ed7486e5",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5f36a76a801571f7ed7486da"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2020-08-14T11:02:03.042-04: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/5f36a76b801571f7ed748723

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZiODAxNTcxZjdlZDc0ODcwOSIsImlkIjoiNWYzNmE3NmI4MDE1NzFmN2VkNzQ4NzBhIiwic2VjcmV0IjoiUjdrUkpBPT0ifQ.3VEUHJFUo5MUPO0x9pRR4F3-_4Avg_kjZaWdCHLItHo

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a76b801571f7ed748723",
  "type": "Note",
  "data": {
    "id": "5f36a76b801571f7ed748723",
    "body": "Et qui facilis velit adipisci sed.",
    "userId": "5f36a76b801571f7ed74871b",
    "createdAt": null,
    "updatedAt": null,
    "notableId": "5f36a76b801571f7ed748716"
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:03.768-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZiODAxNTcxZjdlZDc0ODcyNSIsImlkIjoiNWYzNmE3NmI4MDE1NzFmN2VkNzQ4NzI2Iiwic2VjcmV0IjoiSlZkdXNnPT0ifQ.l5zA4JCf8rOxZVG-Td53DxVhtUmb_lztvC7B-1iP70A

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a76c801571f7ed748741",
  "type": "Note",
  "data": {
    "id": "5f36a76c801571f7ed748741",
    "body": "body",
    "userId": "5f36a76b801571f7ed748726",
    "createdAt": "2020-08-14T15:02:04.115Z",
    "updatedAt": "2020-08-14T15:02:04.115Z",
    "notableId": "5f36a76b801571f7ed748732"
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:04.121-04:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/notes/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/notes/5f36a76d801571f7ed74879a

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZjODAxNTcxZjdlZDc0ODc4MCIsImlkIjoiNWYzNmE3NmM4MDE1NzFmN2VkNzQ4NzgxIiwic2VjcmV0IjoialZLOXZRPT0ifQ.Ascrk0b3u3oe_RslBYEHkqrlmu86-tmuKB-MN6yAbRc

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a76d801571f7ed74879a",
  "type": "Note",
  "data": {
    "id": "5f36a76d801571f7ed74879a",
    "body": "foo",
    "userId": "5f36a76d801571f7ed748792",
    "createdAt": null,
    "updatedAt": "2020-08-14T15:02:05.247Z",
    "notableId": "5f36a76d801571f7ed74878d"
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:05.251-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/notes/:id

Request

Route

DELETE /v1/notes/5f36a76d801571f7ed7487b6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzZkODAxNTcxZjdlZDc0ODc5YyIsImlkIjoiNWYzNmE3NmQ4MDE1NzFmN2VkNzQ4NzlkIiwic2VjcmV0IjoiNnhiV1BBPT0ifQ.yeuN_8uaKxkajhSgsy9D1W-LRMZlWKlo9sJahOq-aeM
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=5f36a771801571f7ed7488b1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzcxODAxNTcxZjdlZDc0ODhiMiIsImlkIjoiNWYzNmE3NzE4MDE1NzFmN2VkNzQ4OGIzIiwic2VjcmV0IjoiRTVDR013PT0ifQ.DhtkCKhU3wsP72Rn5BTtAmNRxDG2jE_qz287p0nJG4s

Query Parameters

challenge_id=5f36a771801571f7ed7488b1

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "QuizMultipleChoiceQuestion",
  "data": [
    {
      "id": "5f36a771801571f7ed7488b6",
      "$type": "QuizMultipleChoiceQuestion",
      "prompt": "Error molestiae repudiandae in facilis est. Sit voluptate quo debitis. Omnis eum at delectus sit magnam. Est sunt incidunt quo. Error qui rem.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "choices": [
        "True",
        "False"
      ],
      "maxSelections": null,
      "answers": [
        0
      ]
    },
    {
      "id": "5f36a771801571f7ed7488b7",
      "$type": "QuizTextQuestion",
      "prompt": "Mollitia delectus sint optio harum id error. Perspiciatis quam dolorem aut maiores repudiandae. Iure praesentium non consequatur corrupti tempore aut.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "minCharacters": 5,
      "maxCharacters": 200,
      "defaultValue": "",
      "matchers": null
    },
    {
      "id": "5f36a771801571f7ed7488b8",
      "$type": "QuizWeightedChoiceQuestion",
      "prompt": "Corporis in est. Qui voluptatem eaque porro facilis excepturi maxime eos. Eaque unde laudantium saepe provident sapiente. Dolorem enim id aspernatur occaecati error facere quia. In atque commodi.",
      "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-08-14T11:02:10.042-04: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/5f36a772801571f7ed7488e0

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzcyODAxNTcxZjdlZDc0ODhkYyIsImlkIjoiNWYzNmE3NzI4MDE1NzFmN2VkNzQ4OGRkIiwic2VjcmV0IjoiMGRsTGV3PT0ifQ.oZQB6G9OeVXtSjjNzopymF_qeLP7BPng-ovBr4Ok-rk

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a772801571f7ed7488e0",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5f36a772801571f7ed7488e0",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "Neque laboriosam non quisquam soluta. Ut exercitationem at in. Quae deleniti laboriosam est placeat ipsam nobis vitae. Ut veritatis dicta. Asperiores assumenda error debitis.",
    "position": null,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": null,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:10.241-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzcyODAxNTcxZjdlZDc0ODhmMSIsImlkIjoiNWYzNmE3NzI4MDE1NzFmN2VkNzQ4OGYyIiwic2VjcmV0Ijoib2dpZlh3PT0ifQ.Z5OBqDFFEhhk1DoIkiwAh0Mdm2OtlWJJJLmevxJ-uWs

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a772801571f7ed7488fd",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5f36a772801571f7ed7488fd",
    "$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-08-14T11:02:10.442-04: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/5f36a772801571f7ed74890b

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzcyODAxNTcxZjdlZDc0ODkwNyIsImlkIjoiNWYzNmE3NzI4MDE1NzFmN2VkNzQ4OTA4Iiwic2VjcmV0IjoielJXSC9BPT0ifQ.yRcdqHHQJgoUkyzdslkbZnXQRmGviL2JU0PhgqzlHuQ

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": "5f36a772801571f7ed74890b",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5f36a772801571f7ed74890b",
    "$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-08-14T11:02:10.703-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/quiz_questions/:id

Request

Route

DELETE /v1/quiz_questions/5f36a772801571f7ed748922

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzcyODAxNTcxZjdlZDc0ODkxZSIsImlkIjoiNWYzNmE3NzI4MDE1NzFmN2VkNzQ4OTFmIiwic2VjcmV0IjoiMHFJeXl3PT0ifQ.YqiMv2L-R0cZj-WaE_8JyCK_8G_0KR_wc5gf9wsscLI
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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzgwODAxNTcxZjdlZDc0OGJjMiIsImlkIjoiNWYzNmE3ODA4MDE1NzFmN2VkNzQ4YmMzIiwic2VjcmV0IjoiNDV2YVV3PT0ifQ.KoFOZ9-35_KnQSOcLWEMSIFbO1mKfJLO1inxZKpVEa0

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "SolutionBrief",
  "data": [
    {
      "id": "5f36a77f801571f7ed748ba5",
      "createdAt": "2020-08-14T15:02:23.633Z",
      "updatedAt": "2020-08-14T15:02:24.147Z",
      "teamId": "5f36a77f801571f7ed748b9f",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T15:02:25.120Z",
      "syncs": 1,
      "schemaVersion": 2,
      "candidateId": "5f36a77f801571f7ed748ba7",
      "teamCandidateId": "5f36a77f801571f7ed748ba8",
      "assessmentResultId": "5f36a77f801571f7ed748bb9",
      "challengeId": "5f36a77f801571f7ed748bb5",
      "sourcedFromId": null,
      "copiedFromId": null,
      "assessmentId": "5f36a77f801571f7ed748bb1",
      "solutionCreatedAt": "2020-08-14T15:01:23.336Z",
      "solutionUpdatedAt": "2020-08-14T15:02:23.569Z",
      "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,
      "baseline": false,
      "sortScore": 0.0,
      "selectionScore": 0.0,
      "knownScore": null,
      "confidenceScore": 0.5,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 1,
      "signalBands": {
        "construct_score": {},
        "strength": {},
        "strength_score": {}
      },
      "attempts": 1,
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "wallTime": 40,
      "testAttempts": 0,
      "totalTestCases": 1,
      "hiddenTestCases": 0,
      "solutionLength": 10,
      "firstTestCaseSolvedAt": "2020-08-14T15:02:23.336Z",
      "completedAt": "2020-08-14T15:02:23.336Z",
      "completedIn": null,
      "language": "javascript",
      "fileCount": null,
      "reopenedCount": null,
      "foreignTestCasesCount": null,
      "usedExternalIde": null,
      "completion": null,
      "answers": null,
      "codeMetrics": null,
      "similarity": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:24.290-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzgxODAxNTcxZjdlZDc0OGMwZCIsImlkIjoiNWYzNmE3ODE4MDE1NzFmN2VkNzQ4YzBlIiwic2VjcmV0IjoiTlRvZXF3PT0ifQ.zEfpjH_FQ5AYSTYk4V8T4BXEJelPLySGXTsD6L9tByU

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "SolutionReview",
  "data": [
    {
      "id": "5f36a781801571f7ed748c10",
      "reviewedById": "5f36a781801571f7ed748c0e",
      "reviewedByStaff": null,
      "assessmentId": "5f36a781801571f7ed748c01",
      "assessmentResultId": "5f36a781801571f7ed748c09",
      "teamCandidateId": "5f36a781801571f7ed748bf8",
      "candidateId": "5f36a781801571f7ed748bf7",
      "challengeId": "5f36a781801571f7ed748c05",
      "solutionId": "5f36a781801571f7ed748bf5",
      "feedback": null,
      "assessmentResultReviewId": "5f36a781801571f7ed748c11",
      "rating": 3,
      "ratingLabel": "Neutral",
      "ratingScore": 0.5,
      "combinedScore": 0.5,
      "qualitiesScore": null,
      "positiveQualityIds": [],
      "negativeQualityIds": [],
      "qualities": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:25.863-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solution_reviews/:id

Request

Route

GET /v1/solution_reviews/5f36a782801571f7ed748c38

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzgyODAxNTcxZjdlZDc0OGMzNSIsImlkIjoiNWYzNmE3ODI4MDE1NzFmN2VkNzQ4YzM2Iiwic2VjcmV0IjoiNnB6VWtnPT0ifQ.FGLwL_k39cCCHe_yAMrVD3YZhjOiTPRmXAopi_pevYM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a782801571f7ed748c38",
  "type": "SolutionReview",
  "data": {
    "id": "5f36a782801571f7ed748c38",
    "reviewedById": "5f36a782801571f7ed748c36",
    "reviewedByStaff": null,
    "assessmentId": "5f36a782801571f7ed748c29",
    "assessmentResultId": "5f36a782801571f7ed748c31",
    "teamCandidateId": "5f36a782801571f7ed748c20",
    "candidateId": "5f36a782801571f7ed748c1f",
    "challengeId": "5f36a782801571f7ed748c2d",
    "solutionId": "5f36a782801571f7ed748c1d",
    "feedback": null,
    "assessmentResultReviewId": "5f36a782801571f7ed748c39",
    "rating": 3,
    "ratingLabel": "Neutral",
    "ratingScore": 0.5,
    "combinedScore": 0.5,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:26.447-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzgyODAxNTcxZjdlZDc0OGM1ZCIsImlkIjoiNWYzNmE3ODI4MDE1NzFmN2VkNzQ4YzVlIiwic2VjcmV0IjoiSDFqTkd3PT0ifQ.FgwKKaTey3oVt3WTSThrG_bDgplLrZEvOkQ8w8NtXus

Body

{
  "data": {
    "feedback": "",
    "solution_id": "5f36a782801571f7ed748c45",
    "assessment_result_review_id": "5f36a782801571f7ed748c60"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a782801571f7ed748c61",
  "type": "SolutionReview",
  "data": {
    "id": "5f36a782801571f7ed748c61",
    "reviewedById": "5f36a782801571f7ed748c5e",
    "reviewedByStaff": false,
    "assessmentId": "5f36a782801571f7ed748c51",
    "assessmentResultId": "5f36a782801571f7ed748c59",
    "teamCandidateId": "5f36a782801571f7ed748c48",
    "candidateId": "5f36a782801571f7ed748c47",
    "challengeId": "5f36a782801571f7ed748c55",
    "solutionId": "5f36a782801571f7ed748c45",
    "feedback": "",
    "assessmentResultReviewId": "5f36a782801571f7ed748c60",
    "rating": null,
    "ratingLabel": null,
    "ratingScore": null,
    "combinedScore": null,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:27.001-04:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/solution_reviews/:id

Parameters

Name Description
data.feedback required data.feedback

Request

Route

PUT /v1/solution_reviews/5f36a783801571f7ed748c85

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzgzODAxNTcxZjdlZDc0OGM4MiIsImlkIjoiNWYzNmE3ODM4MDE1NzFmN2VkNzQ4YzgzIiwic2VjcmV0IjoiZ2ljZk5BPT0ifQ.7Y1PCKOWtXw2ceTjos4F0b5AuwqVNrq5QkdfOagXsTA

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a783801571f7ed748c85",
  "type": "SolutionReview",
  "data": {
    "id": "5f36a783801571f7ed748c85",
    "reviewedById": "5f36a783801571f7ed748c83",
    "reviewedByStaff": false,
    "assessmentId": "5f36a783801571f7ed748c76",
    "assessmentResultId": "5f36a783801571f7ed748c7e",
    "teamCandidateId": "5f36a783801571f7ed748c6d",
    "candidateId": "5f36a783801571f7ed748c6c",
    "challengeId": "5f36a783801571f7ed748c7a",
    "solutionId": "5f36a783801571f7ed748c6a",
    "feedback": "feedback",
    "assessmentResultReviewId": "5f36a783801571f7ed748c86",
    "rating": 3,
    "ratingLabel": "Neutral",
    "ratingScore": 0.5,
    "combinedScore": 0.5,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:27.676-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/solution_reviews/:id

Request

Route

DELETE /v1/solution_reviews/5f36a784801571f7ed748cad

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg0ODAxNTcxZjdlZDc0OGNhYSIsImlkIjoiNWYzNmE3ODQ4MDE1NzFmN2VkNzQ4Y2FiIiwic2VjcmV0IjoiTEVwMER3PT0ifQ.Iyqx6cglXhH4jRoieQ6pTbz7bxaiJXaRnqkNKrWUg8A
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, similarity
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]=5f36a784801571f7ed748ce0

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg0ODAxNTcxZjdlZDc0OGNlZCIsImlkIjoiNWYzNmE3ODQ4MDE1NzFmN2VkNzQ4Y2VlIiwic2VjcmV0IjoiY0RZTEd3PT0ifQ.lDj3jjHEIjdm52sDkxMAshbuNyT73pdk8ntCnQYCEzM

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeSolution",
  "data": [
    {
      "id": "5f36a784801571f7ed748ce5",
      "$type": "CodeSolution",
      "estimatedTime": null,
      "createdAt": "2020-08-14T15:01:28.865Z",
      "updatedAt": "2020-08-14T15:02:28.931Z",
      "challengeId": "5f36a784801571f7ed748ce6",
      "assessmentResultId": "5f36a784801571f7ed748ce1",
      "assessmentId": "5f36a784801571f7ed748cda",
      "candidateId": "5f36a784801571f7ed748cdf",
      "teamCandidateId": "5f36a784801571f7ed748ce0",
      "teamId": "5f36a784801571f7ed748cd4",
      "clonedFromId": null,
      "lastHeartbeat": null,
      "accumulatedSeconds": 0,
      "candidateNotes": null,
      "passingScore": false,
      "language": "javascript",
      "firstTestCaseSolvedAt": "2020-08-14T15:02:28.865Z",
      "completedAt": "2020-08-14T15:02:28.865Z",
      "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,
      "sampleTestCasesReadOnly": false,
      "cursor": {},
      "revisionCount": 0,
      "score": 0.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:28.987-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id/similar

Request

Route

GET /v1/solutions/5f36a787801571f7ed748dd6/similar

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg4ODAxNTcxZjdlZDc0OGRlZSIsImlkIjoiNWYzNmE3ODg4MDE1NzFmN2VkNzQ4ZGVmIiwic2VjcmV0IjoiUXhyL0JnPT0ifQ.pAE4rq8j4iPjydYkxvgnhWLxveM85OAsXbcsyvmg-30

Response

Simulated Response

Status

200

Headers

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

Body

{
  "data": [],
  "meta": {
    "timestamp": "2020-08-14T11:02:32.238-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id/similar

Request

Route

GET /v1/solutions/5f36a787801571f7ed748dd6/similar

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg4ODAxNTcxZjdlZDc0OGRlZSIsImlkIjoiNWYzNmE3ODg4MDE1NzFmN2VkNzQ4ZGVmIiwic2VjcmV0IjoiUXhyL0JnPT0ifQ.pAE4rq8j4iPjydYkxvgnhWLxveM85OAsXbcsyvmg-30

Response

Simulated Response

Status

200

Headers

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

Body

{
  "data": [],
  "meta": {
    "timestamp": "2020-08-14T11:02:32.238-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg4ODAxNTcxZjdlZDc0OGUwMiIsImlkIjoiNWYzNmE3ODg4MDE1NzFmN2VkNzQ4ZTAzIiwic2VjcmV0IjoiUEkwdUtRPT0ifQ.IJtavmNkvMk5preQq6CE76vOnef3F4vvpiTnt4g8iog

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5f36a788801571f7ed748e01",
    "challenge_id": "5f36a788801571f7ed748dfd",
    "language": "javascript"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a788801571f7ed748e08",
  "type": "CodeSolution",
  "data": {
    "id": "5f36a788801571f7ed748e08",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-08-14T15:02:32.696Z",
    "updatedAt": "2020-08-14T15:02:32.696Z",
    "challengeId": "5f36a788801571f7ed748dfd",
    "assessmentResultId": "5f36a788801571f7ed748e01",
    "assessmentId": "5f36a788801571f7ed748df9",
    "candidateId": "5f36a788801571f7ed748e03",
    "teamCandidateId": "5f36a788801571f7ed748e04",
    "teamId": "5f36a788801571f7ed748df3",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": "const add = (a, b) => a * b;",
    "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
    "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,
    "sampleTestCasesReadOnly": false,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:32.714-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg4ODAxNTcxZjdlZDc0OGUxYSIsImlkIjoiNWYzNmE3ODg4MDE1NzFmN2VkNzQ4ZTFiIiwic2VjcmV0IjoiZStubDBnPT0ifQ.OwMGtuwQQNe9J-gVBZ0FPomtU88q1phKyyjFjPPsdnA

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a789801571f7ed748e20",
  "type": "CodeSolution",
  "data": {
    "id": "5f36a789801571f7ed748e20",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-08-14T15:02:33.067Z",
    "updatedAt": "2020-08-14T15:02:33.067Z",
    "challengeId": "5f36a788801571f7ed748e15",
    "assessmentResultId": "5f36a788801571f7ed748e19",
    "assessmentId": "5f36a788801571f7ed748e11",
    "candidateId": "5f36a788801571f7ed748e1b",
    "teamCandidateId": "5f36a788801571f7ed748e1c",
    "teamId": "5f36a788801571f7ed748e0b",
    "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,
    "sampleTestCasesReadOnly": false,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:33.117-04: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/5f36a789801571f7ed748e29

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzg5ODAxNTcxZjdlZDc0OGUyYSIsImlkIjoiNWYzNmE3ODk4MDE1NzFmN2VkNzQ4ZTJiIiwic2VjcmV0IjoiK0hqS3RnPT0ifQ.AjsjvUW2UCT-NltisZU8mJ9lle5sHsQ2-8waKI5nkDI

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": "5f36a789801571f7ed748e29",
  "type": "CodeSolution",
  "data": {
    "id": "5f36a789801571f7ed748e29",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-08-14T15:01:33.302Z",
    "updatedAt": "2020-08-14T15:02:33.633Z",
    "challengeId": "5f36a789801571f7ed748e39",
    "assessmentResultId": "5f36a789801571f7ed748e3d",
    "assessmentId": "5f36a789801571f7ed748e35",
    "candidateId": "5f36a789801571f7ed748e2b",
    "teamCandidateId": "5f36a789801571f7ed748e2c",
    "teamId": "5f36a789801571f7ed748e23",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2020-08-14T15:02:33.302Z",
    "completedAt": "2020-08-14T15:02:33.302Z",
    "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,
    "sampleTestCasesReadOnly": false,
    "cursor": {},
    "revisionCount": 2,
    "score": 100.0
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:33.641-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzhhODAxNTcxZjdlZDc0OGU2MyIsImlkIjoiNWYzNmE3OGE4MDE1NzFmN2VkNzQ4ZTY0Iiwic2VjcmV0Ijoid2lDU0dBPT0ifQ.yJuzPYmib-nL_agRBaJdt8GE0tfvJoegK85iJVxQS_E

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamCandidateBrief",
  "data": [
    {
      "id": "5f36a78a801571f7ed748e70",
      "createdAt": "2020-08-14T15:02:34.273Z",
      "updatedAt": "2020-08-14T15:02:34.324Z",
      "teamId": "5f36a78a801571f7ed748e67",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-08-14T15:02:35.324Z",
      "syncs": 1,
      "candidateId": null,
      "firstName": "Joe",
      "lastName": "Smith673",
      "name": "Joe Smith673",
      "sortName": "Smith673, Joe",
      "anonymousName": "Beige Anteater",
      "email": "[email protected]",
      "state": "invited",
      "sortState": "1",
      "prevState": null,
      "nonArchivedState": "invited",
      "blinding": "blind_reviewers",
      "stems": "j jo joe s sm smi smit smith smith6 smith67 smith673 l lo log logi login logini loginid loginide e ex exa exam examp exampl example b be bei beig beige a an ant ante antea anteat anteate anteater",
      "labels": null,
      "languages": [],
      "redFlags": [],
      "assessmentResultReviews": [],
      "assessmentResults": [],
      "assignedTeamMemberIds": [],
      "reviewedByIds": [],
      "testTeamMember": false,
      "demoData": false,
      "forgotten": null,
      "recentlyAbandoned": false,
      "stateUpdatedAt": "2020-08-14T15:02:34.251Z",
      "teamCandidateUpdatedAt": "2020-08-14T15:02:34.251Z",
      "interactSessionsCount": 0,
      "solutionsCount": 0,
      "submittedAssessmentResultsCount": 0,
      "avgSubmissionScore": null,
      "risks": {
        "total": 0,
        "max": null
      },
      "sortScore": 0.0,
      "selectionScore": 0.0,
      "knownScore": null,
      "confidenceScore": 1.0,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 0,
      "signalBands": {
        "construct_score": {},
        "strength": {},
        "strength_score": {}
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:34.361-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/team_candidate_briefs/:id

Request

Route

GET /v1/team_candidate_briefs/5f36a78a801571f7ed748e80

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzhhODAxNTcxZjdlZDc0OGU3MyIsImlkIjoiNWYzNmE3OGE4MDE1NzFmN2VkNzQ4ZTc0Iiwic2VjcmV0IjoiZ3l5a0dnPT0ifQ.3zEHgzRR8qF-94SVBtGHgoowJzjTBI6oDDLT2QTDKw4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a78a801571f7ed748e80",
  "type": "TeamCandidateBrief",
  "data": {
    "id": "5f36a78a801571f7ed748e80",
    "createdAt": "2020-08-14T15:02:34.557Z",
    "updatedAt": "2020-08-14T15:02:34.610Z",
    "teamId": "5f36a78a801571f7ed748e77",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-08-14T15:02:35.609Z",
    "syncs": 1,
    "candidateId": null,
    "firstName": "Joe",
    "lastName": "Smith675",
    "name": "Joe Smith675",
    "sortName": "Smith675, Joe",
    "anonymousName": "Magenta Bobcat",
    "email": "[email protected]",
    "state": "invited",
    "sortState": "1",
    "prevState": null,
    "nonArchivedState": "invited",
    "blinding": "blind_reviewers",
    "stems": "j jo joe s sm smi smit smith smith6 smith67 smith675 l lo log logi login logini loginid loginide e ex exa exam examp exampl example m ma mag mage magen magent magenta b bo bob bobc bobca bobcat",
    "labels": null,
    "languages": [],
    "redFlags": [],
    "assessmentResultReviews": [],
    "assessmentResults": [],
    "assignedTeamMemberIds": [],
    "reviewedByIds": [],
    "testTeamMember": false,
    "demoData": false,
    "forgotten": null,
    "recentlyAbandoned": false,
    "stateUpdatedAt": "2020-08-14T15:02:34.534Z",
    "teamCandidateUpdatedAt": "2020-08-14T15:02:34.534Z",
    "interactSessionsCount": 0,
    "solutionsCount": 0,
    "submittedAssessmentResultsCount": 0,
    "avgSubmissionScore": null,
    "risks": {
      "total": 0,
      "max": null
    },
    "sortScore": 0.0,
    "selectionScore": 0.0,
    "knownScore": null,
    "confidenceScore": 1.0,
    "opinionScore": null,
    "knownObjectivesScore": null,
    "knownQualitiesScore": null,
    "signalBandsCount": 0,
    "signalBands": {
      "construct_score": {},
      "strength": {},
      "strength_score": {}
    }
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:34.637-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzhiODAxNTcxZjdlZDc0OGVhMiIsImlkIjoiNWYzNmE3OGI4MDE1NzFmN2VkNzQ4ZWEzIiwic2VjcmV0IjoiQVBuWStBPT0ifQ.7-MiAyY0LBwfVRTES5ClVpaj9Wy8D291NKrfHuCQhF8

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamCandidate",
  "data": [
    {
      "id": "5f36a78a801571f7ed748e85",
      "candidateId": "5f36a78a801571f7ed748e84",
      "teamId": "5f36a78a801571f7ed748e88",
      "state": "started",
      "demoData": false,
      "prevState": null,
      "assessmentIds": [
        "5f36a78a801571f7ed748e8e",
        "5f36a78a801571f7ed748e9a"
      ],
      "assessmentResultIds": [
        "5f36a78a801571f7ed748e96",
        "5f36a78a801571f7ed748e9f"
      ],
      "blinding": "blind_reviewers",
      "createdAt": "2020-08-14T15:02:34.780Z",
      "updatedAt": "2020-08-14T15:02:34.992Z",
      "decidedAt": null,
      "invitedAt": null,
      "interactSessions": 0,
      "stateUpdatedAt": "2020-08-14T15:02:34.780Z",
      "testTeamMember": false,
      "assignedTeamMemberIds": [],
      "labels": null,
      "archived": false,
      "firstName": "Joe",
      "lastName": "Smith676",
      "anonymousName": "Cyan Bobcat",
      "email": "[email protected]",
      "name": "Joe Smith676",
      "isBlinded": false,
      "stateLabel": "Assessment Started",
      "stateTransitions": [
        "idle",
        "invited",
        "started",
        "submitted",
        "risk_detected",
        "reviewed",
        "approved",
        "rejected",
        "archived"
      ],
      "risks": null,
      "assessmentsRecap": {
        "id": "5f36a78a801571f7ed748e98",
        "subjects": [
          {
            "id": "5f36a78a801571f7ed748e99",
            "assessmentResultId": "5f36a78a801571f7ed748e96",
            "assessmentId": "5f36a78a801571f7ed748e8e",
            "state": "started"
          },
          {
            "id": "5f36a78a801571f7ed748ea1",
            "assessmentResultId": "5f36a78a801571f7ed748e9f",
            "assessmentId": "5f36a78a801571f7ed748e9a",
            "state": "started"
          }
        ]
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:35.068-04: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/5f36a78d801571f7ed748f4d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzhlODAxNTcxZjdlZDc0OGY2YSIsImlkIjoiNWYzNmE3OGU4MDE1NzFmN2VkNzQ4ZjZiIiwic2VjcmV0Ijoid2FXa2dRPT0ifQ.U3K3ZPFL1ofGEcMP0ZYzKxQxwR_CRvA37SFMzZ5Mne0

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a78d801571f7ed748f4d",
  "type": "TeamCandidate",
  "data": {
    "id": "5f36a78d801571f7ed748f4d",
    "candidateId": "5f36a78d801571f7ed748f4c",
    "teamId": "5f36a78d801571f7ed748f50",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5f36a78d801571f7ed748f56",
      "5f36a78d801571f7ed748f62"
    ],
    "assessmentResultIds": [
      "5f36a78d801571f7ed748f5e",
      "5f36a78e801571f7ed748f67"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-08-14T15:02:37.676Z",
    "updatedAt": "2020-08-14T15:02:38.095Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-08-14T15:02:37.676Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Joe",
    "lastName": "Smith693",
    "anonymousName": "Cerulean Swordfish",
    "email": "[email protected]",
    "name": "Joe Smith693",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5f36a78d801571f7ed748f60",
      "subjects": [
        {
          "id": "5f36a78d801571f7ed748f61",
          "assessmentResultId": "5f36a78d801571f7ed748f5e",
          "assessmentId": "5f36a78d801571f7ed748f56",
          "state": "started"
        },
        {
          "id": "5f36a78e801571f7ed748f69",
          "assessmentResultId": "5f36a78e801571f7ed748f67",
          "assessmentId": "5f36a78d801571f7ed748f62",
          "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-08-14T11:02:38.167-04: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/5f36a78f801571f7ed748fa7

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzkwODAxNTcxZjdlZDc0OGZjNCIsImlkIjoiNWYzNmE3OTA4MDE1NzFmN2VkNzQ4ZmM1Iiwic2VjcmV0IjoiTi9HUFVnPT0ifQ.3h6pqg4-A4NQ08cd2n3aQA15klyaM_VkaJPl48bQscY

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a78f801571f7ed748fa7",
  "type": "TeamCandidate",
  "data": {
    "id": "5f36a78f801571f7ed748fa7",
    "candidateId": "5f36a78f801571f7ed748fa6",
    "teamId": "5f36a78f801571f7ed748faa",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5f36a78f801571f7ed748fb0",
      "5f36a78f801571f7ed748fbc"
    ],
    "assessmentResultIds": [
      "5f36a78f801571f7ed748fb8",
      "5f36a790801571f7ed748fc1"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-08-14T15:02:39.826Z",
    "updatedAt": "2020-08-14T15:02:40.159Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-08-14T15:02:39.826Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": [],
    "archived": false,
    "firstName": "Test",
    "lastName": "Time",
    "anonymousName": "Grey Bobcat",
    "email": "[email protected]",
    "name": "Test Time",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5f36a78f801571f7ed748fba",
      "subjects": [
        {
          "id": "5f36a78f801571f7ed748fbb",
          "assessmentResultId": "5f36a78f801571f7ed748fb8",
          "assessmentId": "5f36a78f801571f7ed748fb0",
          "state": "started"
        },
        {
          "id": "5f36a790801571f7ed748fc3",
          "assessmentResultId": "5f36a790801571f7ed748fc1",
          "assessmentId": "5f36a78f801571f7ed748fbc",
          "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-08-14T11:02:40.299-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzkwODAxNTcxZjdlZDc0OGZlNiIsImlkIjoiNWYzNmE3OTA4MDE1NzFmN2VkNzQ4ZmU3Iiwic2VjcmV0IjoibGs2TFlBPT0ifQ.UdiBh4U4nQgye3a4eDR5jKW-GfsgH7EvT7AZZR2evfo

Body

{
  "ids": [
    "5f36a790801571f7ed748fc9",
    "5f36a790801571f7ed748feb"
  ],
  "bulk_action": "archive",
  "data": {
    "add_labels": [
      "Bulk Archived"
    ]
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a790801571f7ed748fec",
  "type": "TeamCandidateBulkEditOperation",
  "data": {
    "id": "5f36a790801571f7ed748fec",
    "action": "archive",
    "createdAt": "2020-08-14T15:02:40.956Z",
    "lastCompletionAt": null,
    "totalCount": 2,
    "completedCount": 0,
    "todoCount": 2,
    "completionPercentage": 0.0
  },
  "meta": {
    "timestamp": "2020-08-14T11:02:41.063-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/team_candidates/:id

Parameters

Name Description
id required base16 ObjectId

Request

Route

DELETE /v1/team_candidates/5f36a795801571f7ed74912a

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzk2ODAxNTcxZjdlZDc0OTE0OCIsImlkIjoiNWYzNmE3OTY4MDE1NzFmN2VkNzQ5MTQ5Iiwic2VjcmV0IjoiWHAyZ2FBPT0ifQ.3tCN-oyv_64oR9HsvFZ8K-bDF744cQX_wmk9R8NPyRs
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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzk3ODAxNTcxZjdlZDc0OTE5MyIsImlkIjoiNWYzNmE3OTc4MDE1NzFmN2VkNzQ5MTk0Iiwic2VjcmV0IjoieGs1MkNBPT0ifQ.CTqopaHlPnRjeah8ZOWCV9xMsDoPYj2I1XpTAlwGf5k

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamMember",
  "data": [
    {
      "id": "5f36a797801571f7ed74918b",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith757",
      "name": "Joe Smith757",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-08-14T15:02:47.374Z",
      "updatedAt": "2020-08-14T15:02:47.374Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_fg9yjpbrLDMTkEOdVNGxzw",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "hA9YGAspnAvyfg.5f36a797801571f7ed74918b",
      "teamId": "5f36a797801571f7ed74917e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-08-14T15:02:47.368Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5f36a797801571f7ed74918c",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5f36a797801571f7ed749188",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith756",
      "name": "Joe Smith756",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-08-14T15:02:47.340Z",
      "updatedAt": "2020-08-14T15:02:47.340Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_PRn4xbXbuG72zKOyyVPrOA",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "yRtitd0YrizExQ.5f36a797801571f7ed749188",
      "teamId": "5f36a797801571f7ed74917e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-08-14T15:02:47.336Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5f36a797801571f7ed749189",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5f36a797801571f7ed749185",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith755",
      "name": "Joe Smith755",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-08-14T15:02:47.309Z",
      "updatedAt": "2020-08-14T15:02:47.309Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_D0pZSBFr6jVz9uQRAyFV8A",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "Gtdz7VC39Q0qkQ.5f36a797801571f7ed749185",
      "teamId": "5f36a797801571f7ed74917e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-08-14T15:02:47.304Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5f36a797801571f7ed749186",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5f36a797801571f7ed74917a",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith754",
      "name": "Joe Smith754",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-08-14T15:02:47.201Z",
      "updatedAt": "2020-08-14T15:02:47.201Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_4TU7ObRkgMESfmU4MoDhcw",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "Srb3jQtdmcjPyA.5f36a797801571f7ed74917a",
      "teamId": "5f36a797801571f7ed749170",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-08-14T15:02:47.197Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5f36a797801571f7ed74917b",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5f36a797801571f7ed749177",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith753",
      "name": "Joe Smith753",
      "email": "loginid[email protected]",
      "profileImg": null,
      "createdAt": "2020-08-14T15:02:47.161Z",
      "updatedAt": "2020-08-14T15:02:47.161Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_9029KfWkqOnuXBzjoL75KA",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "pNubfzXSpTV6DQ.5f36a797801571f7ed749177",
      "teamId": "5f36a797801571f7ed749170",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-08-14T15:02:47.156Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5f36a797801571f7ed749178",
        "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-08-14T11:02:47.538-04: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/5f36a799801571f7ed74920f?includes[]=team&includes[]=authored_challenges&includes[]=authored_assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzk5ODAxNTcxZjdlZDc0OTIxMSIsImlkIjoiNWYzNmE3OTk4MDE1NzFmN2VkNzQ5MjEyIiwic2VjcmV0IjoiU1dsdGFRPT0ifQ.rAucDuQrSgxFJaHM_9HEgv6jhlXQWHdPnJloh5B5RG4

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a799801571f7ed74920f",
  "type": "TeamMember",
  "data": {
    "id": "5f36a799801571f7ed74920f",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith782",
    "name": "Joe Smith782",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-08-14T15:02:49.162Z",
    "updatedAt": "2020-08-14T15:02:49.162Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_yuJT2YNf7JCtqR3m7Q87UA",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "zLM5s6hGrAaNRQ.5f36a799801571f7ed74920f",
    "teamId": "5f36a799801571f7ed749208",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "team": {
      "id": "5f36a799801571f7ed749208",
      "name": "team317",
      "updatedAt": "2020-08-14T15:02:49.122Z",
      "highConcept": null,
      "website": null,
      "productTypes": {
        "_id": "5f36a799801571f7ed74920b",
        "education": true,
        "recruitment": true
      },
      "customerId": "5f36a799801571f7ed749206",
      "hasDemoData": false,
      "buildingDemoData": false,
      "destroyingDemoData": false,
      "surveysDisabled": null,
      "defaultEnableExternalIde": true,
      "labs": {
        "solutionsReviewDialogPreview": false,
        "externalIde": false
      },
      "logoImg": {
        "id": "5f36a799801571f7ed74920a",
        "fileId": "qrNrnA",
        "fileFormat": "jpg",
        "width": 500,
        "height": 500,
        "url": "//res.cloudinary.com/strive/image/upload/qrNrnA.jpg",
        "rawUrl": "https://s3-us-west-1.amazonaws.com/strive-uploads/qrNrnA.jpg",
        "size": null,
        "brightness": null,
        "background": null
      },
      "createdAt": "2020-08-14T15:02:49.122Z",
      "state": "inactive",
      "publishedAssessmentCount": 0,
      "assessmentResultCount": 0,
      "growthSpeed": "high_growth",
      "companySize": null,
      "engineeringTeamSize": null,
      "referenceInfo": null,
      "notificationScheme": "entire_team",
      "setupAssessmentId": null,
      "setupComplete": false,
      "assessmentNounUpper": "Assessment",
      "showReviewsToReviewers": false,
      "unblindAfterDecision": false,
      "loginProviders": [
        "qualified"
      ],
      "primaryTeam": true,
      "embedDomains": null,
      "bambooConfig": {
        "id": "5f36a799801571f7ed749213",
        "subdomain": null,
        "url": null,
        "jobStatuses": null,
        "jobs": null,
        "lastPollAt": null
      },
      "bambooConnected": false,
      "apiKey": null,
      "zapierApiKey": null,
      "greenhouseApiKey": null,
      "embedClientKey": null,
      "workableApiKey": null,
      "hasBlindReviewers": false,
      "msaSigned": false,
      "desiredFeatures": {
        "id": "5f36a799801571f7ed74920d",
        "takeHome": true
      },
      "progressEvents": {
        "id": "5f36a799801571f7ed749214"
      },
      "nameWasGenerated": false,
      "teamMemberRoleCounts": {
        "owner": 1
      },
      "evaluatedCandidatesMonthly": null,
      "evaluatedCandidatesYearly": null,
      "msaSignedAt": null,
      "msaSignedById": null,
      "samlIssuer": null,
      "samlMetadata": null,
      "samlMetadataUrl": null,
      "utmTracking": {
        "id": "5f36a799801571f7ed74920c",
        "utmSource": "qualified"
      }
    },
    "activatedAt": "2020-08-14T15:02:49.157Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5f36a799801571f7ed749210",
      "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-08-14T11:02:49.263-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzk5ODAxNTcxZjdlZDc0OTIxNSIsImlkIjoiNWYzNmE3OTk4MDE1NzFmN2VkNzQ5MjE2Iiwic2VjcmV0IjoiRVdkeWZBPT0ifQ.3P30viYtJZKWm7kb19uyUGExaQfu96RJx4IPbrEw0Vo

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a799801571f7ed749220",
  "type": "TeamMember",
  "data": {
    "id": "5f36a799801571f7ed749220",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith",
    "name": "Joe Smith",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-08-14T15:02:49.470Z",
    "updatedAt": "2020-08-14T15:02:49.470Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_jLiX3UEY9eWngrHGg9eieA",
    "hasPassword": false,
    "intercomUrl": null,
    "confirmationToken": "Ttqdr35kCD43zg.5f36a799801571f7ed749220",
    "teamId": "5f36a799801571f7ed749219",
    "role": "owner",
    "state": "invited",
    "disabled": false,
    "activatedAt": "2020-08-14T15:02:49.470Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5f36a799801571f7ed749221",
      "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-08-14T11:02:49.484-04: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/5f36a799801571f7ed749225

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhNzk5ODAxNTcxZjdlZDc0OTIyMiIsImlkIjoiNWYzNmE3OTk4MDE1NzFmN2VkNzQ5MjIzIiwic2VjcmV0IjoiVWxRMDVBPT0ifQ.uEYUdgE9vKtSVzame7ZpDmOIvkmCguHT7uzHzDLO-fA

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": "5f36a799801571f7ed749225",
  "type": "TeamMember",
  "data": {
    "id": "5f36a799801571f7ed749225",
    "$type": "TeamMember",
    "firstName": "Test",
    "lastName": "Time",
    "name": "Test Time",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-08-14T15:02:49.655Z",
    "updatedAt": "2020-08-14T15:02:49.706Z",
    "uiPrefs": {
      "theme": "dark"
    },
    "experiments": null,
    "envRoomId": "test_p9Ob36jAOfxUkwpdDH47rQ",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "p0bvbfGqvn7dAg.5f36a799801571f7ed749225",
    "teamId": "5f36a799801571f7ed749228",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "activatedAt": "2020-08-14T15:02:49.576Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5f36a799801571f7ed74922e",
      "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-08-14T11:02:49.715-04: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/5f36a7a1801571f7ed749530?type=AssessmentResult&event=team_candidate.started_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2ExODAxNTcxZjdlZDc0OTUyMCIsImlkIjoiNWYzNmE3YTE4MDE1NzFmN2VkNzQ5NTIxIiwic2VjcmV0IjoiOHJBTUxBPT0ifQ.IIzu94kG1MgJgXAzx4n96htvlM0m9oBV2aMcNevv_u4

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-08-14T15:02:57.551Z",
    "state": "started",
    "submitted_at": null,
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5f36a7a1801571f7ed749530",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith817"
    },
    "team_candidate": {
      "anonymous_name": "Lilac Hyena",
      "prev_state": null,
      "state": "started",
      "id": "5f36a7a1801571f7ed749533"
    },
    "assessment": {
      "labels": null,
      "title": "Senior Web Engineer #202",
      "id": "5f36a7a1801571f7ed74952b"
    },
    "passing_score": false,
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-08-14T15:02:57.617Z",
        "first_test_case_solved_at": "2020-08-14T15:02:57.617Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5f36a7a1801571f7ed749537",
        "passing_score": false,
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Binding Calculator #312",
          "estimated_time": 2,
          "topics": [
            "Algorithms"
          ],
          "summary": null,
          "purpose": null,
          "id": "5f36a7a1801571f7ed74952c"
        }
      }
    ]
  }
}

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/5f36a7a2801571f7ed749549?type=AssessmentResult&event=team_candidate.submitted_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2ExODAxNTcxZjdlZDc0OTUzOSIsImlkIjoiNWYzNmE3YTE4MDE1NzFmN2VkNzQ5NTNhIiwic2VjcmV0IjoiSm92L1JBPT0ifQ._0VWF3f8b8vDsMIi78hA4qiYaGBnfDpP4zs9zpdjVDA

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-08-14T15:02:58.277Z",
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5f36a7a2801571f7ed749549",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith819"
    },
    "team_candidate": {
      "anonymous_name": "Purple Dolphin",
      "prev_state": "invited",
      "state": "submitted",
      "id": "5f36a7a2801571f7ed74954c"
    },
    "assessment": {
      "labels": null,
      "title": "Senior Web Engineer #203",
      "id": "5f36a7a2801571f7ed749544"
    },
    "passing_score": false,
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-08-14T15:02:58.378Z",
        "first_test_case_solved_at": "2020-08-14T15:02:58.378Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5f36a7a2801571f7ed749550",
        "passing_score": false,
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Functional Puzzle #313",
          "estimated_time": 2,
          "topics": [
            "Meta-programming"
          ],
          "summary": null,
          "purpose": null,
          "id": "5f36a7a2801571f7ed749545"
        }
      }
    ]
  }
}

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/5f36a7a2801571f7ed74955d?type=Solution&event=solution.updated

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2EyODAxNTcxZjdlZDc0OTU1MiIsImlkIjoiNWYzNmE3YTI4MDE1NzFmN2VkNzQ5NTUzIiwic2VjcmV0IjoiVE1sMEV3PT0ifQ.hZFZKOw3qbX9B7ELQT0G-PRoHz-Eg4k-5vgAB6RkTxg

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": "5f36a7a2801571f7ed749569",
    "assessment_result_id": "5f36a7a2801571f7ed749571",
    "attempts": 1,
    "completed_at": "2020-08-14T15:02:58.711Z",
    "first_test_case_solved_at": "2020-08-14T15:02:58.711Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5f36a7a2801571f7ed749560",
    "team_id": "5f36a7a2801571f7ed749556",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5f36a7a2801571f7ed74955d",
    "passing_score": false,
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Balanced Game #314",
      "estimated_time": 2,
      "topics": [
        "Algorithms"
      ],
      "summary": null,
      "purpose": null,
      "id": "5f36a7a2801571f7ed74956d"
    }
  }
}

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/5f36a7a3801571f7ed749583?type=TeamCandidate&event=team_candidate.state_changed

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2EzODAxNTcxZjdlZDc0OTU3NiIsImlkIjoiNWYzNmE3YTM4MDE1NzFmN2VkNzQ5NTc3Iiwic2VjcmV0Ijoib2NMTFRnPT0ifQ.7BQgh5qjo9fJ2GRL79TIaqn7Gy-MdLOlPtF8oRAGMk8

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": "Magenta Heron",
    "email": "[email protected]",
    "first_name": "Joe",
    "labels": null,
    "last_name": "Smith824",
    "name": "Joe Smith824",
    "prev_state": null,
    "state": "invited",
    "test_team_member": false,
    "id": "5f36a7a3801571f7ed749583",
    "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/5f36a7a3801571f7ed749590

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2EzODAxNTcxZjdlZDc0OTU4NSIsImlkIjoiNWYzNmE3YTM4MDE1NzFmN2VkNzQ5NTg2Iiwic2VjcmV0IjoiNmNURnJBPT0ifQ.u3Gllm-RgPNXqvERstlTwm6BTydor4l6Sc5Seexpj2U

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": "5f36a7a3801571f7ed74959c",
    "assessment_result_id": "5f36a7a3801571f7ed7495a4",
    "attempts": 1,
    "completed_at": "2020-08-14T15:02:59.403Z",
    "first_test_case_solved_at": "2020-08-14T15:02:59.403Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5f36a7a3801571f7ed749593",
    "team_id": "5f36a7a3801571f7ed749589",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5f36a7a3801571f7ed749590",
    "passing_score": false,
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Balanced Process #315",
      "estimated_time": 2,
      "topics": [
        "Algorithms"
      ],
      "summary": null,
      "purpose": null,
      "id": "5f36a7a3801571f7ed7495a0"
    }
  }
}

Webhook Subscriptions

List

Endpoint

GET /v1/webhook_subscriptions

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/webhook_subscriptions

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2EzODAxNTcxZjdlZDc0OTVhYSIsImlkIjoiNWYzNmE3YTM4MDE1NzFmN2VkNzQ5NWFiIiwic2VjcmV0IjoiOXZWbURnPT0ifQ.0tbXUiNQv9xc7jGRUCHxKZ308f_JW6T_tD4YiiQ_TdM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "WebhookSubscription",
  "data": [
    {
      "id": "5f36a7a3801571f7ed7495b5",
      "name": "Default",
      "url": "https://www.test.com/wpklc",
      "schema": "v1",
      "triggerOnAll": false,
      "eventTriggers": {
        "id": "5f36a7a3801571f7ed7495b6",
        "challengeCreated": true
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-08-14T11:02:59.988-04:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/webhook_subscriptions/:id

Request

Route

GET /v1/webhook_subscriptions/5f36a7a4801571f7ed7495c2

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2E0ODAxNTcxZjdlZDc0OTViNyIsImlkIjoiNWYzNmE3YTQ4MDE1NzFmN2VkNzQ5NWI4Iiwic2VjcmV0IjoieDY1c1hnPT0ifQ.bSoMIr6is_gkgZv64Vt1r9LMHAbbx2H8lDRWiACtKng

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a7a4801571f7ed7495c2",
  "type": "WebhookSubscription",
  "data": {
    "id": "5f36a7a4801571f7ed7495c2",
    "name": "Default",
    "url": "https://www.test.com/pjgsy",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5f36a7a4801571f7ed7495c3",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-08-14T11:03:00.193-04: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.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2E0ODAxNTcxZjdlZDc0OTVjNCIsImlkIjoiNWYzNmE3YTQ4MDE1NzFmN2VkNzQ5NWM1Iiwic2VjcmV0IjoieVRMcVJBPT0ifQ.tviO9A47cSOQDq0UR0pr15LYMtzOM8-slHFO-zoM9Fs

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": "5f36a7a4801571f7ed7495cf",
  "type": "WebhookSubscription",
  "data": {
    "id": "5f36a7a4801571f7ed7495cf",
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5f36a7a4801571f7ed7495d0",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-08-14T11:03:00.384-04: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/5f36a7a4801571f7ed7495eb

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2E0ODAxNTcxZjdlZDc0OTVlMCIsImlkIjoiNWYzNmE3YTQ4MDE1NzFmN2VkNzQ5NWUxIiwic2VjcmV0Ijoib2wwV3BBPT0ifQ.pZ1yXvWmEigpo7gZYe8ncz6PhSYuty3h_tQvcNGIdmg

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5f36a7a4801571f7ed7495eb",
  "type": "WebhookSubscription",
  "data": {
    "id": "5f36a7a4801571f7ed7495eb",
    "name": "My Hook",
    "url": "https://www.test.com/reblt",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5f36a7a4801571f7ed7495ec",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-08-14T11:03:00.795-04:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/webhook_subscriptions/:id

Request

Route

DELETE /v1/webhook_subscriptions/5f36a7a4801571f7ed7495f8

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVmMzZhN2E0ODAxNTcxZjdlZDc0OTVlZCIsImlkIjoiNWYzNmE3YTQ4MDE1NzFmN2VkNzQ5NWVlIiwic2VjcmV0IjoiUGRDOXN3PT0ifQ.AjPmPBuADc7hBVplENbdcXiSm1q555-5IwkYJY8M4G4
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/txott

Headers

Authorization: arj44BWrTotS/DVkXkzjm2TO7tdBhTdB
Content-Type: application/x-www-form-urlencoded

Query Parameters

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

Response

Simulated Response

Status

204