OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Query a task by ID.
4#
5# - Cost complexity: 1
6# - Rate limit: 10 requests / second
7task(id: ID!): Task
8
9# Query a company by ID.
10#
11# Arguments
12# id: The ID of the company to return. If omitted, will default
13# to the ID of the company associated with the API consumer.
14#
15# - Cost complexity: 1
16# - Rate limit: 10 requests / second
17company(id: ID): Company
18
19# [*Internal use only*]
20# Query all companies.
21#
22# - Cost complexity: 3
23# - Rate limit: 5 requests / second
24companies: [Company]
25
26# [*Internal use only*]
27# Query all company features.
28#
29# - Cost complexity: 2
30# - Rate limit: 5 requests / second
31companyFeatures: [CompanyFeature]
32
33# Query a company test by ID.
34#
35# - Cost complexity: 1
36# - Rate limit: 10 requests / second
37#
38# Arguments
39# id: The ID of the company test to return.
40companyTest(id: ID!): CompanyTest
41
42# Query company tests for a given company.
43#
44# - Cost complexity: 1 x first
45# - Rate limit: 10 requests / second
46#
47# Arguments
48# companyId: If omitted, will default to the ID of the company
49# associated with the API consumer.
50# first: Use 'first' and 'offset' arguments to limit results
51# returned
52companyTests(companyId: ID, first: Int!, offset: Int): CompanyTests!
53
54# Query a company test session by ID.
55#
56# - Cost complexity: 1
57# - Rate limit: 10 requests / second
58#
59# Arguments
60# id: The ID of the company test session to return.
61companyTestSession(id: ID!): CompanyTestSession
62
63# Query all company test sessions associated with a given company test ID.
64#
65# - Cost complexity: 1 x first
66# - Rate limit: 10 requests / second
67#
68# Arguments
69# companyTestId: The ID of the company test whose sessions should
70# be returned.
71# first: Use 'first' and 'offset' arguments to limit results
72# returned
73companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
74
75# Query a standardized test session by ID.
76#
77# - Cost complexity: 1
78# - Rate limit: 10 requests / second
79#
80# Arguments
81# id: The ID of the standardized test session to return.
82standardizedTestSession(id: ID!): StandardizedTestSession
83
84# Query a live interview by ID.
85#
86# - Cost complexity: 1
87# - Rate limit: 10 requests / second
88#
89# Arguments
90# liveInterviewId: The ID of the live interview.
91liveInterview(liveInterviewId: ID!): LiveInterview
92
93# Query all live interviews associated with a given candidate email.
94#
95# - Cost complexity: 1 x first
96# - Rate limit: 10 requests / second
97#
98# Arguments
99# candidateEmail: Email of the candidate associated with the
100# interview.
101# first: Use 'first' and 'offset' arguments to limit results
102# returned.
103liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
104
105# Query an interview template by ID.
106#
107# - Cost complexity: 1
108# - Rate limit: 10 requests / second
109#
110# Arguments
111# interviewTemplateId: The ID of the interview template.
112# liveInterviewId: The ID of the interview
113interviewTemplate(interviewTemplateId: ID!, liveInterviewId: ID): InterviewTemplate
114
115# Query all interview templates of a company.
116#
117# - Cost complexity: 1 x first
118# - Rate limit: 10 requests / second
119#
120# Arguments
121# companyId: The ID of the company.
122# globalFilter: Search by template name
123# first: Use 'first' and 'offset' arguments to limit results
124# returned.
125interviewTemplates(
126companyId: ID,
127globalFilter: String,
128first: Int!,
129offset: Int!
130): InterviewTemplates
131
132# Query all roles available to a company
133#
134# - Cost complexity: 2
135# - Rate limit: 5 requests / second
136#
137# Arguments
138# companyId: The ID of the company.
139companyRoles(companyId: ID): [Role]
140
141# [*Internal use only*]
142# Query all system roles.
143#
144# - Cost complexity: 2
145# - Rate limit: 5 requests / second
146systemRoles: [Role]
147
148# Query a specific role by key.
149#
150# - Cost complexity: 1
151# - Rate limit: 10 requests / second
152role(key: ID!): Role
153
154# [*Internal use only*]
155# Query all service plans filtered by the given parameters.
156#
157# - Cost complexity: 2
158# - Rate limit: 5 requests / second
159#
160# Arguments
161# products: Array of CodeSignal assessment products.
162# types: Array of plan types.
163# statuses: Array of plan statuses.
164servicePlans(
165products: [Product],
166types: [PlanType],
167statuses: [ServicePlanStatus]
168): [ServicePlan]
169
170# Query a standardized test by ID.
171#
172# - Cost complexity: 1
173# - Rate limit: 10 requests / second
174#
175# Arguments
176# id: The ID of the test to return.
177standardizedTest(id: ID!): StandardizedTest
178
179# Returns user either by ID or by username. Exactly one field (either userId or
180# username) is required.
181#
182# - Rate limit: 10 requests / second
183#
184# Arguments
185# userId: Unique user ID.
186# username: Username unique for each user.
187user(userId: ID, username: String): User
188
189# [*Internal use only*]
190# Performs an access check for the current user or API key.
191#
192# - Cost complexity: 1
193# - Rate limit: 10 requests / second
194#
195# Arguments
196# type: The type of access being checked.
197# resourceId: The identifier of the resource related to the
198# access check, if a single ID is required.
199# resourceIds: The identifiers of the multiple resources related
200# to the access check, if required.
201hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
202
203# [*Internal use only*]
204# Performs multiple access checks for the current user or API key. Using hasAccess
205# is preferable due to simplicity and
206# better support for client-side caching of results, but hasAccessList can be used
207# when the number of queries is variable
208# and not known in advance.
209#
210# - Cost complexity: 2
211# - Rate limit: 5 requests / second
212hasAccessList(accessQueries: [AccessQueryInput]!): [AccessQueryResult]
213
214# Given the input, returns the corresponding certification request. There are
215# three ways to query for the request:
216# * by unique request ID;
217# * by candidate email and test ID (your company ID will be used implicitly);
218# * by candidate email, test ID and company ID.
219#
220# - Cost complexity: 1
221# - Rate limit: 10 requests / second
222certificationRequest(
223requestFields: CertificationRequestInput!
224): CertificationRequest
225
226}

link Required by

This element is not required by anyone