Skip to main content
GET
/
v1
/
persons
/
{id}
/
documents
Get person documents
curl --request GET \
  --url https://api.stardex.ai/v1/persons/{id}/documents \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "created_at": "2024-02-01T10:00:00Z",
      "updated_at": "2024-02-02T12:00:00Z",
      "type": "resume_doc",
      "title": "John_Doe_Resume.pdf",
      "link": "https://signed-url.example.com/...",
      "text_content": "John Doe\nSoftware Engineer\n\nExperience\nSenior Engineer at Acme Corp (2020–Present)\n- Led platform migration...",
      "char_count": 112,
      "truncated": false
    },
    {
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "type": "cover_letter",
      "title": "Cover_Letter.pdf",
      "link": "https://signed-url.example.com/...",
      "text_content": "Dear Hiring Manager, I am excited to apply for the Senior Engineer role...",
      "char_count": 76,
      "truncated": false
    }
  ],
  "meta": {
    "total": 2,
    "offset": 0,
    "limit": 20
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Person ID

Query Parameters

​
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
​
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
​
include_text
boolean | null
default:false

When true, each document includes its extracted plain-text content (text_content, char_count, truncated). Useful for reading resumes, cover letters, transcripts, etc. Omit or pass false to receive only metadata and signed download links.

​
document_types
string

Comma-separated list of document type keys to filter by. Seeded values: resume_doc, resume_link, cover_letter, reference, additional_links, transcript, work_sample, offer_letter, assessment, other. Omit to return all types.

Response

Documents fetched

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
meta
object
required