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

link Required by

This element is not required by anyone