Create scorecard

curl --request POST \
  --url https://api.stardex.ai/v1/scorecards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "overall_rating": 5,
  "overall_comment": "<string>",
  "is_starred": false,
  "visible_in_client_share_link": false,
  "team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "criterion_ratings": [
    {
      "criterion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rating": 5,
      "comment": "<string>"
    }
  ]
}
'

{
  "success": true,
  "data": {
    "id": "ddddeeee-1111-2222-3333-444444444444",
    "person_id": "123e4567-e89b-12d3-a456-426614174000",
    "job_id": "456e7890-e12b-34d5-a678-901234567890",
    "candidate_id": "eeeeffff-1111-2222-3333-444444444444",
    "assessment_template_id": "aaaa1111-2222-3333-4444-555555555555",
    "template": {
      "id": "aaaa1111-2222-3333-4444-555555555555",
      "name": "Senior Backend Engineer Scorecard",
      "rating_scale": 5
    },
    "job": {
      "id": "456e7890-e12b-34d5-a678-901234567890",
      "title": "Senior Backend Engineer",
      "company_name": "Acme Inc."
    },
    "created_by": {
      "id": "567e8901-e23c-45d6-e789-012345678901",
      "first_name": "Jane",
      "last_name": "Smith"
    },
    "overall_rating": 4.5,
    "overall_comment": "Strong systems-design depth and excellent async collaboration. Recommend moving forward.",
    "is_starred": true,
    "visible_in_client_share_link": false,
    "criterion_ratings": [
      {
        "id": "cc11aa22-3333-4444-5555-666666666666",
        "criterion_id": "bbbb1111-2222-3333-4444-555555555555",
        "criterion_name": "System design depth",
        "importance": "must_have",
        "position": 1,
        "rating": 5,
        "comment": "Designed a multi-region payments service with clear failure-mode reasoning."
      },
      {
        "id": "cc11aa22-3333-4444-5555-777777777777",
        "criterion_id": "cccc1111-2222-3333-4444-555555555555",
        "criterion_name": "Async collaboration",
        "importance": "nice_to_have",
        "position": 2,
        "rating": 4,
        "comment": "Strong written communication; decision log was thorough."
      }
    ],
    "created_at": "2026-06-01T10:00:00Z",
    "updated_at": "2026-06-01T10:00:00Z"
  }
}

Scorecards

Create scorecard

Create a new scorecard (candidate evaluation) for a person.

Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record.

Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both.

Team member assignment: the scorecard is recorded as created by the calling team member by default. Pass team_member_id to attribute creation to a different team member (required when the caller authenticates with an API key).

POST

scorecards

Create scorecard

curl --request POST \
  --url https://api.stardex.ai/v1/scorecards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "overall_rating": 5,
  "overall_comment": "<string>",
  "is_starred": false,
  "visible_in_client_share_link": false,
  "team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "criterion_ratings": [
    {
      "criterion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rating": 5,
      "comment": "<string>"
    }
  ]
}
'

{
  "success": true,
  "data": {
    "id": "ddddeeee-1111-2222-3333-444444444444",
    "person_id": "123e4567-e89b-12d3-a456-426614174000",
    "job_id": "456e7890-e12b-34d5-a678-901234567890",
    "candidate_id": "eeeeffff-1111-2222-3333-444444444444",
    "assessment_template_id": "aaaa1111-2222-3333-4444-555555555555",
    "template": {
      "id": "aaaa1111-2222-3333-4444-555555555555",
      "name": "Senior Backend Engineer Scorecard",
      "rating_scale": 5
    },
    "job": {
      "id": "456e7890-e12b-34d5-a678-901234567890",
      "title": "Senior Backend Engineer",
      "company_name": "Acme Inc."
    },
    "created_by": {
      "id": "567e8901-e23c-45d6-e789-012345678901",
      "first_name": "Jane",
      "last_name": "Smith"
    },
    "overall_rating": 4.5,
    "overall_comment": "Strong systems-design depth and excellent async collaboration. Recommend moving forward.",
    "is_starred": true,
    "visible_in_client_share_link": false,
    "criterion_ratings": [
      {
        "id": "cc11aa22-3333-4444-5555-666666666666",
        "criterion_id": "bbbb1111-2222-3333-4444-555555555555",
        "criterion_name": "System design depth",
        "importance": "must_have",
        "position": 1,
        "rating": 5,
        "comment": "Designed a multi-region payments service with clear failure-mode reasoning."
      },
      {
        "id": "cc11aa22-3333-4444-5555-777777777777",
        "criterion_id": "cccc1111-2222-3333-4444-555555555555",
        "criterion_name": "Async collaboration",
        "importance": "nice_to_have",
        "position": 2,
        "rating": 4,
        "comment": "Strong written communication; decision log was thorough."
      }
    ],
    "created_at": "2026-06-01T10:00:00Z",
    "updated_at": "2026-06-01T10:00:00Z"
  }
}

Authorizations

Authorization

string

header

required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json

person_id

string<uuid>

required

Person UUID being evaluated (required).

assessment_template_id

string<uuid>

required

Scorecard template UUID used to score the person (required).

job_id

string<uuid>

Job UUID to scope this scorecard to. When set, the candidate_id is auto-resolved from the (person_id, job_id) candidate record.

overall_rating

number | null

Overall score (0 to template rating_scale). Optional — leave null to score only at the criterion level.

Required range: 0 <= x <= 10

overall_comment

string

Plain-text overall summary note.

is_starred

boolean

default:false

Whether to mark this scorecard as starred. Defaults to false.

Whether to expose this scorecard on the client share link for the linked job. Only respected when job_id is set. Defaults to false.

team_member_id

string<uuid>

Team member UUID to record as the scorecard creator. Defaults to the caller. Required when the caller is authenticated with an API key (no team member context).

criterion_ratings

object[]

Per-criterion ratings and comments. Each entry must reference a criterion_id belonging to the assessment_template_id and must include a rating, a comment, or both.

Show child attributes

Response

Scorecard created

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

Update scorecard Search tasks