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: [Company]
46
47# [*Internal use only*]
48# Query all company features.
49#
50# - Cost complexity: 2
51# - Rate limit: 5 requests / second
52companyFeatures: [CompanyFeature]
53
54# [*Internal use only*]
55# Query all service plans filtered by the given parameters.
56#
57# - Cost complexity: 2
58# - Rate limit: 5 requests / second
59#
60# Arguments
61# products: Array of CodeSignal assessment products.
62# types: Array of plan types.
63# statuses: Array of plan statuses.
64servicePlans(
65products: [Product],
66types: [PlanType],
67statuses: [ServicePlanStatus]
68): [ServicePlan]
69
70# Query a company test session by ID.
71#
72# - Cost complexity: 1
73# - Rate limit: 10 requests / second
74#
75# Arguments
76# id: The ID of the company test session to return.
77companyTestSession(id: ID!): CompanyTestSession
78
79# Query all company test sessions associated with a given company test ID,
80# ordered by finish date in descending order.
81#
82# - Cost complexity: 1 x first
83# - Rate limit: 10 requests / second
84#
85# Arguments
86# companyTestId: The ID of the company test whose sessions should
87# be returned.
88# first: Use 'first' and 'offset' arguments to limit results
89# returned.
90companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
91
92# Query a standardized test session by ID.
93#
94# - Cost complexity: 1
95# - Rate limit: 10 requests / second
96#
97# Arguments
98# id: The ID of the standardized test session to return.
99standardizedTestSession(id: ID!): StandardizedTestSession
100
101# Query all roles available to a company
102#
103# - Cost complexity: 2
104# - Rate limit: 5 requests / second
105#
106# Arguments
107# companyId: The ID of the company.
108companyRoles(companyId: ID): [Role]
109
110# [*Internal use only*]
111# Query all system roles.
112#
113# - Cost complexity: 2
114# - Rate limit: 5 requests / second
115systemRoles: [Role]
116
117# Query a specific role by key.
118#
119# - Cost complexity: 1
120# - Rate limit: 10 requests / second
121role(key: ID!): Role
122
123# Query a company test by ID.
124#
125# - Cost complexity: 1
126# - Rate limit: 10 requests / second
127#
128# Arguments
129# id: The ID of the company test to return.
130companyTest(id: ID!): CompanyTest
131
132# Query company tests for a given company.
133#
134# - Cost complexity: 1 x first
135# - Rate limit: 10 requests / second
136#
137# Arguments
138# companyId: If omitted, will default to the ID of the company
139# associated with the API consumer.
140# first: Use 'first' and 'offset' arguments to limit results
141# returned
142companyTests(companyId: ID, first: Int!, offset: Int): CompanyTests!
143
144# Query certification tests available for your company.
145#
146# - Cost complexity: 1 x first
147# - Rate limit: 10 requests / second
148#
149# Arguments
150# companyId: If omitted, will default to the ID of the company
151# associated with the API consumer.
152# first: Use 'first' and 'offset' arguments to limit results
153# returned
154certificationTests(companyId: ID, first: Int!, offset: Int): CertificationTests!
155
156# Query a standardized test by ID.
157#
158# - Cost complexity: 1
159# - Rate limit: 10 requests / second
160#
161# Arguments
162# id: The ID of the test to return.
163standardizedTest(id: ID!): StandardizedTest
164
165# Query a live interview by ID.
166#
167# - Cost complexity: 1
168# - Rate limit: 10 requests / second
169#
170# Arguments
171# liveInterviewId: The ID of the live interview.
172liveInterview(liveInterviewId: ID!): LiveInterview
173
174# Query all live interviews associated with a given candidate email.
175#
176# - Cost complexity: 1 x first
177# - Rate limit: 10 requests / second
178#
179# Arguments
180# candidateEmail: Email of the candidate associated with the
181# interview.
182# first: Use 'first' and 'offset' arguments to limit results
183# returned.
184liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
185
186# [*Internal use only*]
187# Performs an access check for the current user or API key.
188#
189# - Cost complexity: 1
190# - Rate limit: 10 requests / second
191#
192# Arguments
193# type: The type of access being checked.
194# resourceId: The identifier of the resource related to the
195# access check, if a single ID is required.
196# resourceIds: The identifiers of the multiple resources related
197# to the access check, if required.
198hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
199
200# [*Internal use only*]
201# Performs multiple access checks for the current user or API key. Using hasAccess
202# is preferable due to simplicity and
203# better support for client-side caching of results, but hasAccessList can be used
204# when the number of queries is variable
205# and not known in advance.
206#
207# - Cost complexity: 2
208# - Rate limit: 5 requests / second
209hasAccessList(accessQueries: [AccessQueryInput]!): [AccessQueryResult]
210
211# Given the input, returns the corresponding certification request. There are
212# three ways to query for the request:
213# * by unique request ID;
214# * by candidate email and test ID (your company ID will be used implicitly);
215# * by candidate email, test ID and company ID.
216#
217# - Cost complexity: 1
218# - Rate limit: 10 requests / second
219certificationRequest(
220requestFields: CertificationRequestInput!
221): CertificationRequest
222
223# Query expired certification requests optionally filtered by:
224# * Standardized test ID.
225# * Expiration date.
226# The results are ordered by the expiration date in descending order.
227#
228# - Cost complexity: 1 x first
229# - Rate limit: 10 requests / second
230#
231# Arguments
232# first: Use 'first' and 'offset' arguments to limit results
233# returned.
234expiredCertificationRequests(
235companyId: ID,
236standardizedTestId: ID,
237expirationDateFrom: Timestamp,
238expirationDateTo: Timestamp,
239first: Int!,
240offset: Int
241): CertificationRequests
242
243# Returns user either by ID or by username. Exactly one field (either userId or
244# username) is required.
245#
246# - Rate limit: 10 requests / second
247#
248# Arguments
249# userId: Unique user ID.
250# username: Username unique for each user.
251user(userId: ID, username: String): User
252
253# Query a task level by task level ID.
254#
255# - Cost complexity: 1
256# - Rate limit: 10 requests / second
257taskLevel(taskLevelId: ID!): TaskLevel
258
259# Query a task by ID.
260#
261# - Cost complexity: 1
262# - Rate limit: 10 requests / second
263task(id: ID!): SingleEnvironmentTask
264
265# [*Internal use only*]
266# Query tasks by sourceName.
267#
268# - Cost complexity: 1
269# - Rate limit: 10 requests / second
270codesignalCreatedTasks(name: String!): [CommonTask]
271
272}

link Required by

This element is not required by anyone