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#
81# - Cost complexity: 1 x first
82# - Rate limit: 10 requests / second
83#
84# Arguments
85# companyTestId: The ID of the company test whose sessions should
86# be returned.
87# first: Use 'first' and 'offset' arguments to limit results
88# returned
89companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
90
91# Query a standardized test session by ID.
92#
93# - Cost complexity: 1
94# - Rate limit: 10 requests / second
95#
96# Arguments
97# id: The ID of the standardized test session to return.
98standardizedTestSession(id: ID!): StandardizedTestSession
99
100# Query all roles available to a company
101#
102# - Cost complexity: 2
103# - Rate limit: 5 requests / second
104#
105# Arguments
106# companyId: The ID of the company.
107companyRoles(companyId: ID): [Role]
108
109# [*Internal use only*]
110# Query all system roles.
111#
112# - Cost complexity: 2
113# - Rate limit: 5 requests / second
114systemRoles: [Role]
115
116# Query a specific role by key.
117#
118# - Cost complexity: 1
119# - Rate limit: 10 requests / second
120role(key: ID!): Role
121
122# Query a company test by ID.
123#
124# - Cost complexity: 1
125# - Rate limit: 10 requests / second
126#
127# Arguments
128# id: The ID of the company test to return.
129companyTest(id: ID!): CompanyTest
130
131# Query company tests for a given company.
132#
133# - Cost complexity: 1 x first
134# - Rate limit: 10 requests / second
135#
136# Arguments
137# companyId: If omitted, will default to the ID of the company
138# associated with the API consumer.
139# first: Use 'first' and 'offset' arguments to limit results
140# returned
141companyTests(companyId: ID, first: Int!, offset: Int): CompanyTests!
142
143# Query a standardized test by ID.
144#
145# - Cost complexity: 1
146# - Rate limit: 10 requests / second
147#
148# Arguments
149# id: The ID of the test to return.
150standardizedTest(id: ID!): StandardizedTest
151
152# Query a live interview by ID.
153#
154# - Cost complexity: 1
155# - Rate limit: 10 requests / second
156#
157# Arguments
158# liveInterviewId: The ID of the live interview.
159liveInterview(liveInterviewId: ID!): LiveInterview
160
161# Query all live interviews associated with a given candidate email.
162#
163# - Cost complexity: 1 x first
164# - Rate limit: 10 requests / second
165#
166# Arguments
167# candidateEmail: Email of the candidate associated with the
168# interview.
169# first: Use 'first' and 'offset' arguments to limit results
170# returned.
171liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
172
173# [*Internal use only*]
174# Performs an access check for the current user or API key.
175#
176# - Cost complexity: 1
177# - Rate limit: 10 requests / second
178#
179# Arguments
180# type: The type of access being checked.
181# resourceId: The identifier of the resource related to the
182# access check, if a single ID is required.
183# resourceIds: The identifiers of the multiple resources related
184# to the access check, if required.
185hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
186
187# [*Internal use only*]
188# Performs multiple access checks for the current user or API key. Using hasAccess
189# is preferable due to simplicity and
190# better support for client-side caching of results, but hasAccessList can be used
191# when the number of queries is variable
192# and not known in advance.
193#
194# - Cost complexity: 2
195# - Rate limit: 5 requests / second
196hasAccessList(accessQueries: [AccessQueryInput]!): [AccessQueryResult]
197
198# Given the input, returns the corresponding certification request. There are
199# three ways to query for the request:
200# * by unique request ID;
201# * by candidate email and test ID (your company ID will be used implicitly);
202# * by candidate email, test ID and company ID.
203#
204# - Cost complexity: 1
205# - Rate limit: 10 requests / second
206certificationRequest(
207requestFields: CertificationRequestInput!
208): CertificationRequest
209
210# Returns user either by ID or by username. Exactly one field (either userId or
211# username) is required.
212#
213# - Rate limit: 10 requests / second
214#
215# Arguments
216# userId: Unique user ID.
217# username: Username unique for each user.
218user(userId: ID, username: String): User
219
220# Query a task by ID.
221#
222# - Cost complexity: 1
223# - Rate limit: 10 requests / second
224task(id: ID!): Task
225
226}

link Required by

This element is not required by anyone