/application-form-templates

Lists the application form templates available to your team, so you can reference a template when creating a job.

Results include every template owned by your team or, if your team has a parent team, that parent team — regardless of who created the template. The API does not currently restrict results further by creator or by template-sharing settings: any caller authenticated for a team sees the full set of templates owned by that team and its parent team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

This ID is used to identify the specific team record in the Apploi platform whose application form templates are being requested.

This ID is assigned by Apploi automatically when a team record is first created and is unique to each team. The value of the team_id can be found in each of the items returned in the response data of a call to the /applicants endpoint. If the JSON body of the response were assigned to a variable called response then the team ID for the first item could be accessed through the following nested attribute reference: response.data[0].job.team_id (JavaScript), response['data'][0]['job']['team_id'] (Python).

Examples: 123456, 789012

string

Filters the returned templates by which stage of the hiring funnel they belong to.

Accepted values: First Stage (the initial application a candidate fills out), Second Stage (an optional secondary screener), Interview Guide (filled out by the interviewer, not the candidate — interview_guide is also accepted as an exact alias), and Not Interview Guide (a shorthand for "every template whose group is set to something other than Interview Guide" — not_interview_guide is also accepted as an exact alias).

Matching is case-sensitive and only recognizes these exact strings — a value like interview guide or INTERVIEW GUIDE will not match and returns an empty data array rather than an error, the same as any other unrecognized value; an empty result does not necessarily mean your team has no templates.

Not Interview Guide also excludes templates whose group is unset (null), not only ones set to Interview Guide — a team whose templates are all ungrouped can get an empty result from this value even though those same templates are returned when the parameter is omitted entirely.

Omit this parameter to return templates from every group, including ungrouped ones.

Examples: First Stage, Interview Guide, Not Interview Guide

Responses

400

400 response

403

Invalid Token

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json