API Reference
Push candidates, applications, clients, and jobs into your Talynce organization, manage pipeline status, and read screening results using API keys.
Paid plan required
REST API access is available on paid plans (2+ users) and during legacy trial evaluation. Free solo accounts cannot create API keys or call /api/v1/* endpoints.
Base URL: https://talynce.com/api/v1
Requires a paid plan. Create keys in Dashboard → Administration → Developer. OpenAPI spec: https://talynce.com/api/v1/openapi.json
All request and response bodies are JSON. Field names use snake_case. Unless noted, types below use standard JSON types.
Common data types
| Field | Type | Meaning | Description |
|---|---|---|---|
| string | JSON string | — | UTF-8 text |
| string (uuid) | string | — | UUID v4, e.g. 550e8400-e29b-41d4-a716-446655440000 |
| string (ISO 8601 date-time) | string | — | string (ISO 8601 date-time) |
| string (YYYY-MM-DD) | string | — | string (YYYY-MM-DD) |
| integer | number | — | Whole number |
| number | number | — | Decimal number (float) |
| boolean | boolean | — | true or false |
| string[] | array | — | Array of strings |
| object | object | — | JSON object (arbitrary keys) |
| object[] | array | — | Array of objects |
| T | null | union | — | Field may be null in responses |
Response envelope
| Field | Type | — | Description |
|---|---|---|---|
| data | object | object[] | — | Resource body or array of resources |
| meta.total | integer | — | Total matching records |
| meta.limit | integer | — | Page size used |
| meta.offset | integer | — | Offset used |
| Field | Type | — | Description |
|---|---|---|---|
| error.code | string | — | Machine-readable error code |
| error.message | string | — | Human-readable message |
| error.details | object | — | Optional extra context |