OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Query an interview template by ID.
4#
5# - Cost complexity: 1
6# - Rate limit: 10 requests / second
7#
8# Arguments
9# interviewTemplateId: The ID of the interview template.
10# liveInterviewId: The ID of the interview
11interviewTemplate(interviewTemplateId: ID!, liveInterviewId: ID): InterviewTemplate
12
13# Query all interview templates of a company.
14#
15# - Cost complexity: 1 x first
16# - Rate limit: 10 requests / second
17#
18# Arguments
19# companyId: The ID of the company.
20# globalFilter: Search by template name
21# first: Use 'first' and 'offset' arguments to limit results
22# returned.
23interviewTemplates(
24companyId: ID,
25globalFilter: String,
26first: Int!,
27offset: Int!
28): InterviewTemplates
29
30# Query the most recently used interview templates of a company, ordered from most
31# to least
32# recently used.
33#
34# - Cost complexity: 1
35# - Rate limit: 10 requests / second
36#
37# Arguments
38# companyId: The ID of the company.
39# limit: Maximum number of templates to return.
40recentInterviewTemplates(companyId: ID, limit: Int!): [InterviewTemplate!]!
41
42# Query a company by ID.
43#
44# Arguments
45# id: The ID of the company to return. If omitted, will default
46# to the ID of the company associated with the API consumer.
47#
48# - Cost complexity: 1
49# - Rate limit: 10 requests / second
50company(id: ID): Company
51
52# [*Internal use only*]
53# Query all companies.
54#
55# - Cost complexity: 3
56# - Rate limit: 5 requests / second
57companies(
58offset: Int,
59first: Int,
60clientType: ClientType,
61companySearchText: String,
62companyStatus: String,
63companyFeatures: [String]
64): Companies
65
66# Query the frameworks you have access to view with pagination and filtering.
67#
68# - Cost complexity: 1 x first
69# - Rate limit: 10 requests / second
70#
71# Arguments
72# globalFilter: Search by framework title.
73# first: Use 'first' and 'offset' arguments to limit results
74# returned.
75# ids: Filter by specific framework IDs. Only frameworks with
76# matching IDs will be returned.
77frameworks(globalFilter: String, first: Int!, offset: Int, ids: [ID!]): Frameworks!
78
79# Query company test sessions by ATS-specific ID.
80#
81# - Cost complexity: 2
82# - Rate limit: 10 requests / second
83#
84# Arguments
85# id: The ID of the ATS application or candidate to retrieve test
86# sessions for.
87# idType: The type of ID specified.
88atsCompanyTestSessions(id: String!, idType: AtsIdType!): [CompanyTestSession]!
89
90# Query a company test session by ID.
91#
92# - Cost complexity: 2
93# - Rate limit: 10 requests / second
94#
95# Arguments
96# id: The ID of the company test session to return.
97companyTestSession(id: ID!): CompanyTestSession
98
99# Query all company test sessions associated with a given company test ID,
100# ordered by finish date in descending order.
101#
102# - Cost complexity: 2 x first
103# - Rate limit: 10 requests / second
104#
105# Arguments
106# companyTestId: The ID of the company test whose sessions should
107# be returned.
108# first: Use 'first' and 'offset' arguments to limit results
109# returned.
110# ids: Filter by specific test session IDs. Only sessions with
111# matching IDs will be returned.
112companyTestSessions(
113companyTestId: ID!,
114first: Int,
115offset: Int,
116ids: [ID!]
117): [CompanyTestSession]!
118
119# Query a standardized test session by ID.
120#
121# - Cost complexity: 2
122# - Rate limit: 10 requests / second
123#
124# Arguments
125# id: The ID of the standardized test session to return.
126standardizedTestSession(id: ID!): StandardizedTestSession
127
128# Query all roles available to a company
129#
130# - Cost complexity: 2
131# - Rate limit: 5 requests / second
132#
133# Arguments
134# companyId: The ID of the company.
135companyRoles(companyId: ID): [Role]
136
137# [*Internal use only*]
138# Query all system roles.
139#
140# - Cost complexity: 2
141# - Rate limit: 5 requests / second
142systemRoles: [Role]
143
144# Query a specific role by key.
145#
146# - Cost complexity: 1
147# - Rate limit: 10 requests / second
148role(key: ID!): Role
149
150# Query a company test by ID.
151#
152# - Cost complexity: 1
153# - Rate limit: 10 requests / second
154#
155# Arguments
156# id: The ID of the company test to return.
157companyTest(id: ID!): CompanyTest
158
159# Query company tests for a given company.
160#
161# - Cost complexity: 1 x first
162# - Rate limit: 10 requests / second
163#
164# Arguments
165# companyId: If omitted, will default to the ID of the company
166# associated with the API consumer.
167# first: Use 'first' and 'offset' arguments to limit results
168# returned
169# ids: Filter by specific test IDs. Only tests with matching IDs
170# will be returned.
171# titleSearchText: Search tests by title. Case-insensitive
172# partial match.
173# labels: Filter tests by labels. Only tests that have all
174# specified labels will be returned.
175# sortBy: The field to sort results by. Defaults to 'title'.
176# sortDirection: The direction to sort results. Defaults to
177# 'asc'.
178# targetUserId: Filter by visibility for the specified user. When
179# provided, only tests visible to
180# this user are returned. The target user must belong to the queried company.
181# Requires sufficient permissions to view tests on behalf of the specified user.
182companyTests(
183companyId: ID,
184first: Int!,
185offset: Int,
186ids: [ID!],
187titleSearchText: String,
188labels: [String!],
189sortBy: CompanyTestSortBy,
190sortDirection: SortDirection,
191targetUserId: ID
192): CompanyTests!
193
194# Query certification tests available for your company.
195#
196# - Cost complexity: 1 x first
197# - Rate limit: 10 requests / second
198#
199# Arguments
200# companyId: If omitted, will default to the ID of the company
201# associated with the API consumer.
202# first: Use 'first' and 'offset' arguments to limit results
203# returned
204certificationTests(companyId: ID, first: Int!, offset: Int): CertificationTests!
205
206# Query a standardized test by ID.
207#
208# - Cost complexity: 1
209# - Rate limit: 10 requests / second
210#
211# Arguments
212# id: The ID of the test to return.
213standardizedTest(id: ID!): StandardizedTest
214
215# Query a live interview by ID.
216#
217# - Cost complexity: 1
218# - Rate limit: 10 requests / second
219#
220# Arguments
221# liveInterviewId: The ID of the live interview.
222liveInterview(liveInterviewId: ID!): LiveInterview
223
224# Query all live interviews optionally filtered by candidate email.
225#
226# - Cost complexity: 1 x first
227# - Rate limit: 10 requests / second
228#
229# Arguments
230# candidateEmail: Email of the candidate associated with the
231# interview.
232# first: Use 'first' and 'offset' arguments to limit results
233# returned.
234liveInterviews(candidateEmail: String, first: Int, offset: Int): [LiveInterview]!
235
236# [*Internal use only*]
237# Performs an access check for the current user or API key.
238#
239# - Cost complexity: 1
240# - Rate limit: 10 requests / second
241#
242# Arguments
243# type: The type of access being checked.
244# resourceId: The identifier of the resource related to the
245# access check, if a single ID is required.
246# resourceIds: The identifiers of the multiple resources related
247# to the access check, if required.
248hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
249
250# [*Internal use only*]
251# Performs multiple access checks for the current user or API key. Using hasAccess
252# is preferable due to simplicity and
253# better support for client-side caching of results, but hasAccessList can be used
254# when the number of queries is variable
255# and not known in advance.
256#
257# - Cost complexity: 2
258# - Rate limit: 5 requests / second
259hasAccessList(accessQueries: [AccessQueryInput!]!): [AccessQueryResult]
260
261# [*Internal use only*]
262# Query task sets with pagination.
263#
264# - Cost complexity: 1 x first
265# - Rate limit: 10 requests / second
266#
267# Arguments
268# first: Use 'first' and 'offset' arguments to limit results
269# returned
270taskSets(first: Int!, offset: Int): TaskSets!
271
272# Query test labels for a company.
273#
274# Returns test labels that can be applied to assessments, with optional search
275# filtering.
276#
277# - Cost complexity: 1 x first
278# - Rate limit: 10 requests / second
279#
280# Arguments
281# companyId: The ID of the company to query test labels for.
282# If omitted, will default to the ID of the company associated with the API
283# consumer.
284# searchText: Optional search string for partial match filtering
285# on label titles.
286# The search is case-insensitive.
287# first: Maximum number of results to return. Required.
288# offset: Number of results to skip for pagination.
289testLabels(companyId: ID, searchText: String, first: Int!, offset: Int): TestLabels!
290
291# Returns user either by ID or by username. Exactly one field (either userId or
292# username) is required.
293#
294# - Rate limit: 10 requests / second
295#
296# Arguments
297# userId: Unique user ID.
298# username: Username unique for each user.
299user(userId: ID, username: String): User
300
301# [*Internal use only*]
302# Query AI interviewers with pagination.
303#
304# - Cost complexity: 1 x first
305# - Rate limit: 10 requests / second
306#
307# Arguments
308# first: Use 'first' and 'offset' arguments to limit results
309# returned
310aiInterviewers(first: Int!, offset: Int): AiInterviewers!
311
312# [*Internal use only*]
313# Returns the list of unique domains across all active AI interviewers.
314#
315# - Cost complexity: 1
316# - Rate limit: 10 requests / second
317aiInterviewerDomains: [String!]!
318
319# [*Internal use only*]
320# Query LLM model categories with pagination.
321#
322# - Cost complexity: 1
323# - Rate limit: 10 requests / second
324#
325# Arguments
326# first: Use 'first' and 'offset' arguments to limit results
327# returned
328llmModelCategories(first: Int!, offset: Int): LlmModelCategories!
329
330# Query a question level by question level ID.
331#
332# - Cost complexity: 1
333# - Rate limit: 10 requests / second
334taskLevel(taskLevelId: ID!): TaskLevel
335
336# Query a question by ID.
337#
338# - Cost complexity: 1
339# - Rate limit: 10 requests / second
340task(id: ID!): SingleEnvironmentTask
341
342# [*Internal use only*]
343# Query questions by sourceName.
344#
345# - Cost complexity: 1
346# - Rate limit: 10 requests / second
347codesignalCreatedTasks(name: String!): [CommonTask]
348
349# Query a filesystem question by ID. Works for all filesystem question types
350# (free-filesystem, scorable-filesystem, and AI-checker variants).
351#
352# - Cost complexity: 1
353# - Rate limit: 10 requests / second
354filesystemTask(id: ID!): FilesystemTask
355
356}

link Required by

This element is not required by anyone