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

link Required by

This element is not required by anyone