People

Retrieve a person

Retrieve a person

Required scopes: people:read

Example (curl):

curl https://api.yardstick.team/v1/people/per_abc123 \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/people/per_abc123", {
  headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` },
}).then((r) => r.json());
get/v1/people/{person_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/people/{person_id}
  • Auth: HTTP bearer

Path parameters

person_idstring required

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

idstring required

Display id, e.g. per_<base32>

object'person' required
namestring nullable required
emailstring nullable required
phonestring nullable required
linkedin_urlstring nullable required
resume_urlstring nullable required
notesstring nullable required
livemodeboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.