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