---
title: "List available placeholders"
method: GET
path: "/template-placeholders"
tags: ["Template Placeholders"]
---

# List available placeholders

`GET /template-placeholders`

## Request

- Base URL: `https://api.100hires.com/v2`
- URL: `https://api.100hires.com/v2/template-placeholders`
- Auth: HTTP bearer

Returns available placeholders for email templates with pagination.

**Workflow:** Use this endpoint to discover placeholders, then call `POST /template-placeholders/prepare` with the chosen placeholder to get an HTML tag. Insert that tag into the email template body.

Use `type` to filter by category, `q` to search by label.

## Query parameters

- `company_id` integer
- `type` 'profile_field' | 'job_variable' | 'questionnaire_link' | 'self_scheduling_link'
- `is_notification` 0 | 1
- `q` string
- `page` integer
- `size` integer

## Response `200`

Placeholder list

- TemplatePlaceholderListResponse
  - `placeholders` TemplatePlaceholder[], required: Array of placeholders.
    - `type` string: Placeholder type (system, candidate_column, job_variable, questionnaire_link, scheduling_link)
    - `identifier` unknown
    - `label` string: Human-readable label
    - `is_link` boolean: Whether this placeholder renders as a link
    - `is_job_variable` boolean: Whether this is a job variable placeholder
    - `job_variable_id` integer: Job variable ID (for job_variable type)
    - `system_column_title` string: System column title (for candidate_column type)
    - `qas_profile_question_id` integer: Profile question ID (for candidate_column type)
    - `form_question_id` integer: Form question ID (for candidate_column type)
    - `form_name` string: Form name (for form question placeholders)
  - `pagination` Pagination, required
    - `page_size` integer, required: Items per page.
    - `page_count` integer, required: Total number of pages.
    - `page` integer, required: Current page number.
    - `total_count` integer, required: Total number of items.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests

---

[API](https://skmtc.dev/100hires/apis/100hires-api.md) · [All operations](https://skmtc.dev/100hires/apis/100hires-api/llms.txt) · [OpenAPI document](https://skmtc.dev/100hires/apis/100hires-api/revisions/e63e2d3115f7?raw)
