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

link Required by

This element is not required by anyone