---
title: "Listing jobs templates"
method: GET
path: "/job-templates"
tags: ["Job Templates"]
---

# Listing jobs templates

`GET /job-templates`

Returns a list of job templates.

## Query parameters

- `id` integer
- `name` string
- `type` 'vacancy_type_apprentice' | 'vacancy_type_associate' | 'vacancy_type_talent_pool' | 'vacancy_type_effective' | 'vacancy_type_internship' | 'vacancy_type_summer' | 'vacancy_type_temporary' | 'vacancy_type_outsource' | 'vacancy_type_trainee' | 'vacancy_type_volunteer' | 'vacancy_legal_entity' | 'vacancy_type_lecturer' | 'vacancy_type_freelancer' | 'vacancy_type_autonomous' | 'vacancy_type_intermittent'
- `careerPageId` integer
- `roleId` integer
- `fields` string
- `perPage` integer
- `page` integer

## Response `200`

An array of job templates

- PaginatedJobTemplates — An array of job templates
  - `results` JobTemplate[], required
    - `id` integer — Template ID
    - `name` string — Job name (eg. Programador Node.js)
    - `type` 'vacancy_type_apprentice' | 'vacancy_type_associate' | 'vacancy_type_talent_pool' | 'vacancy_type_effective' | 'vacancy_type_internship' | 'vacancy_type_summer' | 'vacancy_type_temporary' | 'vacancy_type_outsource' | 'vacancy_type_trainee' | 'vacancy_type_volunteer' | 'vacancy_legal_entity' | 'vacancy_type_lecturer' | 'vacancy_type_freelancer' | 'vacancy_type_autonomous' | 'vacancy_type_intermittent' — Job type (eg. vacancy_type_effective, vacancy_type_internship)
    - `departmentId` integer — Department ID
    - `departmentName` string — Department name (eg. Recursos Humanos, Logística)
    - `roleId` integer — Role ID
    - `roleName` string — Role name (eg. Desenvolvedor, Estagiário)
    - `branchId` integer — Branch ID
    - `branchName` string — Branch name
    - `description` string — Job description
    - `responsibilities` string — Main responsabilities and attribuitions
    - `prerequisites` string — Requirements and skills
    - `additionalInformation` string — Additional relevant informations
    - `notes` string — Internal notes about the job
    - `disabilities` boolean — Available for person with disabilities
    - `addressStreet` string — Job address street
    - `addressDistrict` string — Job address district
    - `addressComplements` string — Job address complements
    - `addressNumber` string — Job address number
    - `addressCity` string — Job address city
    - `addressState` string — Job address state
    - `addressStateShortName` string — Job address short state name
    - `addressCountry` string — Job address country
    - `addressCountryShortName` string — Job address short country name
    - `addressZipCode` string — Job address zip code
    - `addressLatitude` number, double — Work location latitude.
    - `addressLongitude` number, double — Work location longitude.
    - `remoteWorking` boolean — This job is for remote working. This field will soon be deprecated, please use workplaceType instead for setting remoteWorking accurately.
    - `workplaceType` 'hybrid' | 'on-site' | 'remote' — Workplace type. If provided, will be used to set the remoteWorking correctly.
    - `reason` 'staff_increase' | 'staff_replacement' — Job opening reason
    - `image` string — Image url for job website
    - `socialMediaImage` string — Image url for social media
    - `careerPageId` integer — Career page ID
    - `careerPageName` string — Career page name
    - `customFields` JobTemplateCustomField[] — Custom fields defined for this job template
      - `id` string — Custom field id
      - `label` string — Custom field label
      - `value` union — Custom field provided value
        - string
        - string[]
      - `type` 'select' | 'multiSelect' | 'text' | 'boolean' | 'number' | 'date' | 'time' — Custom field type
      - `order` integer — Custom field order of appearance when editing a job template
      - `required` boolean — Informs if this custom field response is mandatory
      - `enum` string[] — Possible options to be provided as value
  - `totalResults` integer
  - `page` integer
  - `totalPages` integer

## Other responses

- `400` — BadRequest / Invalid Input
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/gupy/apis/gupy-public-api.md) · [All operations](https://skmtc.net/gupy/apis/gupy-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gupy/gupy-public-api/revisions/3f26defa2a42/schema)