Create an application
Create an application
Required scopes: applications:write
Use this endpoint when a user asks to create or add a candidate for a job. Create or reuse the Person first, then create the Application; the resulting record appears through read-only opportunity views and the app's Candidates surfaces. If the prerequisite Person is unavailable, the response is 404 person_not_found with param: person_id; if the prerequisite Job Posting is unavailable, it is 404 job_posting_not_found with param: job_posting_id. A later application read still uses application_not_found with param: application_id.
Example (curl):
curl -X POST https://api.yardstick.team/v1/applications \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: 7c3a…' \
-d '{"person_id":"per_abc123","job_posting_id":"jp_xyz789"}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/applications", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({
person_id: "per_abc123",
job_posting_id: "jp_xyz789",
}),
});
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/applications
- Auth: HTTP bearer
Headers
Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.
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.
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.