> ## Documentation Index > Fetch the complete documentation index at: https://docs.taptalent.io/llms.txt > Use this file to discover all available pages before exploring further. # List jobs > Retrieve a paginated list of all jobs in your company. The response is a bare object (no `status`/`data` envelope) containing the page of jobs and the total job count. Each job in the list carries the standard job fields plus list-only fields: `pipelineStage` (pipeline stages with per-stage candidate counts), `createdAt` (epoch timestamp), `runningRevenue` (total revenue from hired candidates), and `rejectedCandidateCount`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /jobs openapi: 3.1.0 info: title: TapTalent Partner API version: 1.0.0 summary: Partner API for jobs, candidates, pipelines, custom fields, and webhooks. description: > The TapTalent Partner API lets partner systems manage jobs, candidates, job-candidate relationships, hiring pipelines, and custom fields, and receive real-time event notifications via webhooks. All communication is JSON over HTTPS. ## Authentication Every request requires an API key sent as an HTTP bearer token: ``` Authorization: Bearer sk_live_AbCdEfGhIjKlMnOpQrStUv ``` Keys are prefixed `sk_live_` (production) or `sk_test_` (sandbox) followed by 22 base62 characters, are scoped to a company, and are generated from the TapTalent dashboard (Account Settings → Developers → API Key Management). Key management is dashboard-only and not available via this API. ## Response envelopes The API uses three envelope styles, by resource family: | Family | Success envelope | |---|---| | Jobs | Bare object (e.g. `{ "jobs": [...], "totalJobs": 45 }` or the job object itself) | | Candidates, Job Candidates, Pipelines, Custom Fields | `{ "status": "success", "data": ... }` | | Bulk resume upload and batch retrieval | `{ "success": true, "data": ... }` | Each operation in this specification models its family's actual envelope; no unified envelope is imposed. ## Pagination Pagination conventions vary by endpoint and are modeled as documented: | Endpoint | Page parameter | First page | Default page size | Page size rule | |---|---|---|---|---| | `GET /jobs` | `pageNumber` | 1 | 10 | one of 10, 20, 40, 80, 100 | | `GET /candidates/list` | `pageNumber` | **0** | 10 | one of 10, 20, 40, 80, 100 | | `GET /candidates/batch/{batchId}` | `pageNumber` | 1 | 10 | one of 10, 20, 40, 80, 100 | | `GET /job-candidates/job/{jobId}/candidates` | `page` | 1 | 20 | one of 10, 20, 40, 80, 100 | | `GET /job-candidates/stage/{stageId}/candidates` | `page` | 1 | 20 | any value from 1 to 100 | ## Errors Most errors use the canonical envelope: ```json { "error": { "code": "ERROR_CODE", "type": "error_type", "message": "Human-readable error message", "details": { "field": "Specific validation error message" } } } ``` Authentication failures use flat shapes instead (`{"message": ...}`, `{"code": ..., "message": ...}` or `{"message": ..., "isApiKeyExists": false}`); see the shared 401 response. Rate limits are applied at the company level; numeric limits and the 429 response body are not yet published. ## Webhooks Event notifications are delivered as HTTP POST requests to a single company-level HTTPS endpoint configured in the dashboard. Deliveries carry the headers `X-Webhook-Event`, `X-Webhook-Timestamp`, and `X-Webhook-Key` (verify by plain equality against the key generated in the dashboard; HMAC signatures are not yet available). Endpoints must respond with a 2xx status within 5 seconds; failed deliveries are retried at 200 ms, 400 ms, and 800 ms before being marked failed. See the `webhooks` section of this document for every event payload. ## Conventions used in this specification - `x-inferred: true` marks schemas or responses whose shape is inferred from related endpoints because the source documentation does not include an example; verify against the sandbox before relying on exact field names. - `x-known-quirk` marks fields whose wire format deviates from the API's prevailing conventions (for example an epoch timestamp where other endpoints return ISO 8601 strings). - Where the published documentation shows placeholder string identifiers (for example `"pipelineId_1"` or `"companyId_1"`), this specification models the underlying integer identifier types used by the API and notes the resolution on the affected field. contact: name: TapTalent Support email: support@taptalent.ai url: https://docs.taptalent.io license: name: Proprietary url: https://taptalent.ai servers: - url: https://partner-api.taptalent.io/v1/partner description: Production (use `sk_live_` keys) - url: https://sandbox.partner-api.taptalent.io/v1/partner description: Sandbox / staging (use `sk_test_` keys) security: - bearerAuth: [] tags: - name: Jobs description: Create, read, update, and list jobs. - name: Candidates description: >- Create and retrieve candidates, upload resumes in bulk, and fetch candidates by batch or id list. - name: Job Candidates description: >- Manage the relationship between candidates and jobs, including stage placement and per-job resume ingestion. - name: Pipelines description: Manage hiring pipelines and their stages. - name: Custom Fields description: Define custom field templates for candidates and jobs. - name: Custom Field Values description: Read and write custom field values attached to candidates and jobs. - name: Webhooks description: >- Event notifications delivered to your configured webhook endpoint. See the top-level `webhooks` section for payloads. paths: /jobs: get: tags: - Jobs summary: List jobs description: | Retrieve a paginated list of all jobs in your company. The response is a bare object (no `status`/`data` envelope) containing the page of jobs and the total job count. Each job in the list carries the standard job fields plus list-only fields: `pipelineStage` (pipeline stages with per-stage candidate counts), `createdAt` (epoch timestamp), `runningRevenue` (total revenue from hired candidates), and `rejectedCandidateCount`. operationId: listJobs parameters: - name: pageNumber in: query required: false description: Page number. The first page is 1. schema: type: integer default: 1 - name: perPage in: query required: false description: 'Items per page. Must be one of: 10, 20, 40, 80, 100.' schema: type: integer enum: - 10 - 20 - 40 - 80 - 100 default: 10 responses: '200': description: Paginated list of jobs. content: application/json: schema: $ref: '#/components/schemas/ListJobsResponse' examples: jobList: summary: One page of jobs value: jobs: - id: 12345 title: Senior Software Engineer description: We are looking for an experienced software engineer... city: San Francisco state: California country: United States pipelineId: 181 status: DRAFT workMode: REMOTE pipelineStage: - name: Applied type: APPLIED totalCandidate: 5 - name: Interview type: INTERVIEW totalCandidate: 2 createdAt: 1234567890 runningRevenue: 0 rejectedCandidateCount: 1 salaryRangeFrom: 120000 salaryRangeTo: 180000 salaryCurrency: USD totalJobs: 45 '400': description: > Invalid pagination parameters. HTTP status inferred from the error category; the source documentation specifies the body but not the status code. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: invalidPerPage: summary: Invalid perPage value value: error: code: INVALID_PER_PAGE type: validation_error message: 'perPage must be one of: 10, 20, 40, 80, 100' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' components: schemas: ListJobsResponse: type: object description: Bare (unenveloped) response of the list jobs endpoint. required: - jobs - totalJobs properties: jobs: type: array description: Array of job objects for the requested page. items: $ref: '#/components/schemas/JobSummary' totalJobs: type: integer description: Total number of jobs in your company. ApiError: type: object description: Canonical error envelope used by most non-authentication errors. required: - error properties: error: $ref: '#/components/schemas/ApiErrorBody' JobSummary: type: object description: | Job shape returned by the list endpoint. Includes the standard job fields plus list-only fields: `pipelineStage` (stages with candidate counts), `createdAt`, `runningRevenue`, and `rejectedCandidateCount`. required: - id - title - city - state - country - pipelineId - status - workMode - pipelineStage - createdAt properties: id: type: integer description: Unique identifier of the job. title: type: string description: Job title displayed to candidates. description: type: string description: Detailed job description. city: type: string description: Job location city. state: type: string description: Job location state/province. country: type: string description: Job location country. pipelineId: type: integer description: | Identifier of the hiring pipeline attached to the job. The published documentation shows the placeholder string "pipelineId_1"; the API uses the integer pipeline id (as in the Pipelines API). examples: - 181 status: $ref: '#/components/schemas/JobStatus' workMode: $ref: '#/components/schemas/WorkMode' pipelineStage: type: array description: Pipeline stages of the job with per-stage candidate counts. items: $ref: '#/components/schemas/JobPipelineStage' createdAt: type: integer x-known-quirk: epoch-timestamp description: | Timestamp when the job was created, as a Unix epoch integer. Note this deviates from the API's prevailing convention — other endpoints return ISO 8601 timestamp strings. examples: - 1234567890 runningRevenue: type: number description: Total revenue from hired candidates. rejectedCandidateCount: type: integer description: Number of rejected candidates. salaryRangeFrom: type: integer description: Minimum annual salary. salaryRangeTo: type: integer description: Maximum annual salary. salaryCurrency: $ref: '#/components/schemas/SalaryCurrency' ApiErrorBody: type: object description: Canonical error object carried under the `error` key. required: - code - type - message properties: code: type: string description: Machine-readable error code, e.g. `INVALID_REQUEST`. examples: - INVALID_REQUEST type: type: string description: Error category. enum: - validation_error - internal_error - not_found - authorization_error - resource_error - payment_error - subscription_error message: type: string description: Human-readable error message. details: type: object description: Optional per-field validation messages or structured error context. additionalProperties: true AuthMessageError: type: object description: >- Flat authentication error shape (does not use the canonical `error` envelope). required: - message properties: message: type: string examples: - Invalid API key AuthCodeMessageError: type: object description: >- Flat authentication error shape returned when the account subscription is inactive. required: - code - message properties: code: type: string examples: - ACCOUNT_INACTIVE message: type: string examples: - >- Your subscription is inactive. Please renew your plan to continue using this feature. AuthApiKeyError: type: object description: >- Flat authentication error shape returned when the API key does not exist. required: - message - isApiKeyExists properties: message: type: string examples: - API key not found isApiKeyExists: type: boolean JobStatus: type: string description: | Job lifecycle status. The documented lifecycle path is `DRAFT` → `ACTIVE` → `INACTIVE` → `DELETED`. The only documented restriction is that once a job leaves `DRAFT` it can never return to `DRAFT`; other reverse transitions (e.g. reactivation) are not documented either way. When creating a job only `DRAFT` and `ACTIVE` are allowed (see `JobStatusCreate`). enum: - DRAFT - ACTIVE - INACTIVE - DELETED WorkMode: type: string description: | Work arrangement for the position. `ONSITE` (default at creation): work at a physical office location; `REMOTE`: work from anywhere; `HYBRID`: a combination of onsite and remote work. enum: - ONSITE - REMOTE - HYBRID JobPipelineStage: type: object description: >- A pipeline stage of a job, with the number of candidates currently in it. required: - name - type - totalCandidate properties: name: type: string description: Stage display name. examples: - Applied type: type: string description: Stage type identifier (e.g. `APPLIED`, `INTERVIEW`). examples: - APPLIED totalCandidate: type: integer description: Number of candidates currently in this stage. SalaryCurrency: type: string description: Currency code for the salary range. enum: - USD - PHP - SGD - IDR - EUR - INR - GBP - AED - MYR - AUD - CAD - JPY - CNY - CHF - ZAR - KRW - THB - VND - BRL - MXN - RUB - TRY - SEK - NOK - DKK - PLN - HKD - MAD responses: Unauthorized: description: | Authentication failed. Note that authentication errors use flat body shapes rather than the canonical `error` envelope. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthMessageError' - $ref: '#/components/schemas/AuthCodeMessageError' - $ref: '#/components/schemas/AuthApiKeyError' examples: invalidApiKey: summary: Invalid API key value: message: Invalid API key accountInactive: summary: Subscription inactive value: code: ACCOUNT_INACTIVE message: >- Your subscription is inactive. Please renew your plan to continue using this feature. apiKeyNotFound: summary: API key not found value: message: API key not found isApiKeyExists: false TooManyRequests: x-inferred: true description: | Rate limit exceeded. Rate limits are applied at the company level; the response body below is inferred because the current documentation mentions handling 429 responses but does not publish a body. Retry with exponential backoff. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: rateLimited: summary: Rate limit exceeded (inferred example) value: error: code: RATE_LIMIT_EXCEEDED type: validation_error message: Too many requests. Please retry with exponential backoff. InternalError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: internalError: summary: Internal error value: error: code: INTERNAL_ERROR type: internal_error message: Something went wrong. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: | Company-scoped API key. Production keys are prefixed `sk_live_`, sandbox keys `sk_test_`, each followed by 22 base62 characters (pattern `^sk_(live|test)_[0-9A-Za-z]{22}$`). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration. ````