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 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 company test sessions by ATS-specific ID.
71#
72# - Cost complexity: 2
73# - Rate limit: 10 requests / second
74#
75# Arguments
76# id: The ID of the ATS application or candidate to retrieve test
77# sessions for.
78# idType: The type of ID specified.
79atsCompanyTestSessions(id: String!, idType: AtsIdType!): [CompanyTestSession]!
80
81# Query a company test session by ID.
82#
83# - Cost complexity: 2
84# - Rate limit: 10 requests / second
85#
86# Arguments
87# id: The ID of the company test session to return.
88companyTestSession(id: ID!): CompanyTestSession
89
90# Query all company test sessions associated with a given company test ID,
91# ordered by finish date in descending order.
92#
93# - Cost complexity: 2 x first
94# - Rate limit: 10 requests / second
95#
96# Arguments
97# companyTestId: The ID of the company test whose sessions should
98# be returned.
99# first: Use 'first' and 'offset' arguments to limit results
100# returned.
101companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
102
103# Query a standardized test session by ID.
104#
105# - Cost complexity: 2
106# - Rate limit: 10 requests / second
107#
108# Arguments
109# id: The ID of the standardized test session to return.
110standardizedTestSession(id: ID!): StandardizedTestSession
111
112# Query all roles available to a company
113#
114# - Cost complexity: 2
115# - Rate limit: 5 requests / second
116#
117# Arguments
118# companyId: The ID of the company.
119companyRoles(companyId: ID): [Role]
120
121# [*Internal use only*]
122# Query all system roles.
123#
124# - Cost complexity: 2
125# - Rate limit: 5 requests / second
126systemRoles: [Role]
127
128# Query a specific role by key.
129#
130# - Cost complexity: 1
131# - Rate limit: 10 requests / second
132role(key: ID!): Role
133
134# Query a company test by ID.
135#
136# - Cost complexity: 1
137# - Rate limit: 10 requests / second
138#
139# Arguments
140# id: The ID of the company test to return.
141companyTest(id: ID!): CompanyTest
142
143# Query company tests for a given company.
144#
145# - Cost complexity: 1 x first
146# - Rate limit: 10 requests / second
147#
148# Arguments
149# companyId: If omitted, will default to the ID of the company
150# associated with the API consumer.
151# first: Use 'first' and 'offset' arguments to limit results
152# returned
153companyTests(companyId: ID, first: Int!, offset: Int): CompanyTests!
154
155# Query certification tests available for your company.
156#
157# - Cost complexity: 1 x first
158# - Rate limit: 10 requests / second
159#
160# Arguments
161# companyId: If omitted, will default to the ID of the company
162# associated with the API consumer.
163# first: Use 'first' and 'offset' arguments to limit results
164# returned
165certificationTests(companyId: ID, first: Int!, offset: Int): CertificationTests!
166
167# Query a standardized test by ID.
168#
169# - Cost complexity: 1
170# - Rate limit: 10 requests / second
171#
172# Arguments
173# id: The ID of the test to return.
174standardizedTest(id: ID!): StandardizedTest
175
176# Query a live interview by ID.
177#
178# - Cost complexity: 1
179# - Rate limit: 10 requests / second
180#
181# Arguments
182# liveInterviewId: The ID of the live interview.
183liveInterview(liveInterviewId: ID!): LiveInterview
184
185# Query all live interviews optionally filtered by candidate email.
186#
187# - Cost complexity: 1 x first
188# - Rate limit: 10 requests / second
189#
190# Arguments
191# candidateEmail: Email of the candidate associated with the
192# interview.
193# first: Use 'first' and 'offset' arguments to limit results
194# returned.
195liveInterviews(candidateEmail: String, first: Int, offset: Int): [LiveInterview]!
196
197# [*Internal use only*]
198# Performs an access check for the current user or API key.
199#
200# - Cost complexity: 1
201# - Rate limit: 10 requests / second
202#
203# Arguments
204# type: The type of access being checked.
205# resourceId: The identifier of the resource related to the
206# access check, if a single ID is required.
207# resourceIds: The identifiers of the multiple resources related
208# to the access check, if required.
209hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
210
211# [*Internal use only*]
212# Performs multiple access checks for the current user or API key. Using hasAccess
213# is preferable due to simplicity and
214# better support for client-side caching of results, but hasAccessList can be used
215# when the number of queries is variable
216# and not known in advance.
217#
218# - Cost complexity: 2
219# - Rate limit: 5 requests / second
220hasAccessList(accessQueries: [AccessQueryInput!]!): [AccessQueryResult]
221
222# Returns user either by ID or by username. Exactly one field (either userId or
223# username) is required.
224#
225# - Rate limit: 10 requests / second
226#
227# Arguments
228# userId: Unique user ID.
229# username: Username unique for each user.
230user(userId: ID, username: String): User
231
232# Query a question level by question level ID.
233#
234# - Cost complexity: 1
235# - Rate limit: 10 requests / second
236taskLevel(taskLevelId: ID!): TaskLevel
237
238# Query a question by ID.
239#
240# - Cost complexity: 1
241# - Rate limit: 10 requests / second
242task(id: ID!): SingleEnvironmentTask
243
244# [*Internal use only*]
245# Query questions by sourceName.
246#
247# - Cost complexity: 1
248# - Rate limit: 10 requests / second
249codesignalCreatedTasks(name: String!): [CommonTask]
250
251}

link Required by

This element is not required by anyone