Skip to main content
GET
/
candidates
/
{candidate_id}
Get Candidate
curl --request GET \
  --url https://api.example.com/candidates/{candidate_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "format": "<string>",
  "drug_class": "<string>",
  "format_metadata": {},
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source_antibody_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "antigen_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "initial_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
candidate_id
string<uuid>
required

Response

Successful Response

Candidate enriched with junction-table IDs.

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
name
string
required
​
format
string
required
​
drug_class
string
required
​
format_metadata
Format Metadata · object
required
​
description
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
source_antibody_ids
string<uuid>[]
​
antigen_ids
string<uuid>[]
​
initial_variant_id
string<uuid> | null