OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Query a task by ID.
4task(id: ID!): Task
5
6# Query a company by ID.
7#
8# Arguments
9# id: The ID of the company to return.
10company(id: ID!): Company
11
12# Query all companies.
13companies: [Company]
14
15# Query all company features.
16companyFeatures: [CompanyFeature]
17
18# Query a company test by ID.
19#
20# Arguments
21# id: The ID of the company test to return.
22companyTest(id: ID!): CompanyTest
23
24# Query company tests for a given company.
25#
26# Arguments
27# companyId: If omitted, will default to the ID of the company
28# associated with the API consumer.
29# first: Use 'first' and 'offset' arguments to limit results
30# returned
31companyTests(companyId: ID, first: Int!, offset: Int): CompanyTests!
32
33# Query a company test session by ID.
34#
35# Arguments
36# id: The ID of the company test session to return.
37companyTestSession(id: ID!): CompanyTestSession
38
39# Query all company test sessions associated with a given company test ID.
40#
41# Arguments
42# companyTestId: The ID of the company test whose sessions should
43# be returned.
44# first: Use 'first' and 'offset' arguments to limit results
45# returned
46companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
47
48# Query a standardized test session by ID.
49#
50# Arguments
51# id: The ID of the standardized test session to return.
52standardizedTestSession(id: ID!): StandardizedTestSession
53
54# Query a live interview by ID.
55#
56# Arguments
57# liveInterviewId: The ID of the live interview.
58liveInterview(liveInterviewId: ID!): LiveInterview
59
60# Query all live interviews associated with a given candidate email.
61#
62# Arguments
63# candidateEmail: Email of the candidate associated with the
64# interivew.
65# first: Use 'first' and 'offset' arguments to limit results
66# returned.
67liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
68
69# Query all system roles.
70systemRoles: [Role]
71
72# Query a specific role by key.
73role(key: ID!): Role
74
75# Query all service plans filtered by the give params.
76#
77# Arguments
78# products: Array of CodeSignal assessment products.
79# types: Array of plan types.
80# statuses: Array of plan statuses.
81servicePlans(
82products: [Product],
83types: [PlanType],
84statuses: [ServicePlanStatus]
85): [ServicePlan]
86
87# Query a standardized test by ID.
88#
89# Arguments
90# id: The ID of the test to return.
91standardizedTest(id: ID!): StandardizedTest
92
93# Returns user either by ID or by username. Exactly one field (either userId or
94# username) is required.
95#
96# Arguments
97# userId: Unique user ID.
98# username: Username unique for each user.
99user(userId: ID, username: String): User
100
101# Performs an access check for the current user or API key.
102#
103# Arguments
104# type: The type of access being checked.
105# resourceId: The identifier of the resource related to the
106# access check, if a single ID is required.
107# resourceIds: The identifiers of the multiple resources related
108# to the access check, if required.
109hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
110
111# Performs multiple access checks for the current user or API key. Using hasAccess
112# is preferable due to simplicity and
113# better support for client-side caching of results, but hasAccessList can be used
114# when the number of queries is variable
115# and not known in advance.
116hasAccessList(accessQueries: [AccessQueryInput]!): [AccessQueryResult]
117
118# Given the input, returns the corresponding certification request. There are
119# three ways to query for the request:
120# * by unique request ID;
121# * by candidate email and test ID (your company ID will be used implicitly);
122# * by candidate email, test ID and company ID.
123certificationRequest(
124requestFields: CertificationRequestInput!
125): CertificationRequest
126
127}

link Required by

This element is not required by anyone