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 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. 64 ( 65 : [Product], 66 : [PlanType], 67 : [ServicePlanStatus] 68 ): [ServicePlan] 69 70 # [*Internal use only*] 71 # Query frameworks with pagination and filtering. 72 # 73 # - Cost complexity: 1 x first 74 # - Rate limit: 10 requests / second 75 # 76 # Arguments 77 # globalFilter: Search by framework title. 78 # first: Use 'first' and 'offset' arguments to limit results 79 # returned. 80 # ids: Filter by specific framework IDs. Only frameworks with 81 # matching IDs will be returned. 82 (: String, : Int!, : Int, : [ID!]): Frameworks! 83 84 # Query company test sessions by ATS-specific ID. 85 # 86 # - Cost complexity: 2 87 # - Rate limit: 10 requests / second 88 # 89 # Arguments 90 # id: The ID of the ATS application or candidate to retrieve test 91 # sessions for. 92 # idType: The type of ID specified. 93 (: String!, : AtsIdType!): [CompanyTestSession]! 94 95 # Query a company test session by ID. 96 # 97 # - Cost complexity: 2 98 # - Rate limit: 10 requests / second 99 # 100 # Arguments 101 # id: The ID of the company test session to return. 102 (: ID!): CompanyTestSession 103 104 # Query all company test sessions associated with a given company test ID, 105 # ordered by finish date in descending order. 106 # 107 # - Cost complexity: 2 x first 108 # - Rate limit: 10 requests / second 109 # 110 # Arguments 111 # companyTestId: The ID of the company test whose sessions should 112 # be returned. 113 # first: Use 'first' and 'offset' arguments to limit results 114 # returned. 115 # ids: Filter by specific test session IDs. Only sessions with 116 # matching IDs will be returned. 117 ( 118 : ID!, 119 : Int, 120 : Int, 121 : [ID!] 122 ): [CompanyTestSession]! 123 124 # Query a standardized test session by ID. 125 # 126 # - Cost complexity: 2 127 # - Rate limit: 10 requests / second 128 # 129 # Arguments 130 # id: The ID of the standardized test session to return. 131 (: ID!): StandardizedTestSession 132 133 # Query all roles available to a company 134 # 135 # - Cost complexity: 2 136 # - Rate limit: 5 requests / second 137 # 138 # Arguments 139 # companyId: The ID of the company. 140 (: ID): [Role] 141 142 # [*Internal use only*] 143 # Query all system roles. 144 # 145 # - Cost complexity: 2 146 # - Rate limit: 5 requests / second 147 : [Role] 148 149 # Query a specific role by key. 150 # 151 # - Cost complexity: 1 152 # - Rate limit: 10 requests / second 153 (: ID!): Role 154 155 # Query a company test by ID. 156 # 157 # - Cost complexity: 1 158 # - Rate limit: 10 requests / second 159 # 160 # Arguments 161 # id: The ID of the company test to return. 162 (: ID!): CompanyTest 163 164 # Query company tests for a given company. 165 # 166 # - Cost complexity: 1 x first 167 # - Rate limit: 10 requests / second 168 # 169 # Arguments 170 # companyId: If omitted, will default to the ID of the company 171 # associated with the API consumer. 172 # first: Use 'first' and 'offset' arguments to limit results 173 # returned 174 # ids: Filter by specific test IDs. Only tests with matching IDs 175 # will be returned. 176 # titleSearchText: Search tests by title. Case-insensitive 177 # partial match. 178 # labels: Filter tests by labels. Only tests that have all 179 # specified labels will be returned. 180 # sortBy: The field to sort results by. Defaults to 'title'. 181 # sortDirection: The direction to sort results. Defaults to 182 # 'asc'. 183 # targetUserId: Filter by visibility for the specified user. When 184 # provided, only tests visible to 185 # this user are returned. The target user must belong to the queried company. 186 # Requires sufficient permissions to view tests on behalf of the specified user. 187 ( 188 : ID, 189 : Int!, 190 : Int, 191 : [ID!], 192 : String, 193 : [String!], 194 : CompanyTestSortBy, 195 : SortDirection, 196 : ID 197 ): CompanyTests! 198 199 # Query certification tests available for your company. 200 # 201 # - Cost complexity: 1 x first 202 # - Rate limit: 10 requests / second 203 # 204 # Arguments 205 # companyId: If omitted, will default to the ID of the company 206 # associated with the API consumer. 207 # first: Use 'first' and 'offset' arguments to limit results 208 # returned 209 (: ID, : Int!, : Int): CertificationTests! 210 211 # Query a standardized test by ID. 212 # 213 # - Cost complexity: 1 214 # - Rate limit: 10 requests / second 215 # 216 # Arguments 217 # id: The ID of the test to return. 218 (: ID!): StandardizedTest 219 220 # Query a live interview by ID. 221 # 222 # - Cost complexity: 1 223 # - Rate limit: 10 requests / second 224 # 225 # Arguments 226 # liveInterviewId: The ID of the live interview. 227 (: ID!): LiveInterview 228 229 # Query all live interviews optionally filtered by candidate email. 230 # 231 # - Cost complexity: 1 x first 232 # - Rate limit: 10 requests / second 233 # 234 # Arguments 235 # candidateEmail: Email of the candidate associated with the 236 # interview. 237 # first: Use 'first' and 'offset' arguments to limit results 238 # returned. 239 (: String, : Int, : Int): [LiveInterview]! 240 241 # [*Internal use only*] 242 # Performs an access check for the current user or API key. 243 # 244 # - Cost complexity: 1 245 # - Rate limit: 10 requests / second 246 # 247 # Arguments 248 # type: The type of access being checked. 249 # resourceId: The identifier of the resource related to the 250 # access check, if a single ID is required. 251 # resourceIds: The identifiers of the multiple resources related 252 # to the access check, if required. 253 (: AccessType!, : ID, : [ID]): Boolean 254 255 # [*Internal use only*] 256 # Performs multiple access checks for the current user or API key. Using hasAccess 257 # is preferable due to simplicity and 258 # better support for client-side caching of results, but hasAccessList can be used 259 # when the number of queries is variable 260 # and not known in advance. 261 # 262 # - Cost complexity: 2 263 # - Rate limit: 5 requests / second 264 (: [AccessQueryInput!]!): [AccessQueryResult] 265 266 # [*Internal use only*] 267 # Query task sets with pagination. 268 # 269 # - Cost complexity: 1 x first 270 # - Rate limit: 10 requests / second 271 # 272 # Arguments 273 # first: Use 'first' and 'offset' arguments to limit results 274 # returned 275 (: Int!, : Int): TaskSets! 276 277 # Query test labels for a company. 278 # 279 # Returns test labels that can be applied to assessments, with optional search 280 # filtering. 281 # 282 # - Cost complexity: 1 x first 283 # - Rate limit: 10 requests / second 284 # 285 # Arguments 286 # companyId: The ID of the company to query test labels for. 287 # If omitted, will default to the ID of the company associated with the API 288 # consumer. 289 # searchText: Optional search string for partial match filtering 290 # on label titles. 291 # The search is case-insensitive. 292 # first: Maximum number of results to return. Required. 293 # offset: Number of results to skip for pagination. 294 (: ID, : String, : Int!, : Int): TestLabels! 295 296 # Returns user either by ID or by username. Exactly one field (either userId or 297 # username) is required. 298 # 299 # - Rate limit: 10 requests / second 300 # 301 # Arguments 302 # userId: Unique user ID. 303 # username: Username unique for each user. 304 (: ID, : String): User 305 306 # [*Internal use only*] 307 # Query AI interviewers with pagination. 308 # 309 # - Cost complexity: 1 x first 310 # - Rate limit: 10 requests / second 311 # 312 # Arguments 313 # first: Use 'first' and 'offset' arguments to limit results 314 # returned 315 (: Int!, : Int): AiInterviewers! 316 317 # [*Internal use only*] 318 # Returns the list of unique domains across all active AI interviewers. 319 # 320 # - Cost complexity: 1 321 # - Rate limit: 10 requests / second 322 : [String!]! 323 324 # [*Internal use only*] 325 # Query LLM model categories with pagination. 326 # 327 # - Cost complexity: 1 328 # - Rate limit: 10 requests / second 329 # 330 # Arguments 331 # first: Use 'first' and 'offset' arguments to limit results 332 # returned 333 (: Int!, : Int): LlmModelCategories! 334 335 # Query a question level by question level ID. 336 # 337 # - Cost complexity: 1 338 # - Rate limit: 10 requests / second 339 (: ID!): TaskLevel 340 341 # Query a question by ID. 342 # 343 # - Cost complexity: 1 344 # - Rate limit: 10 requests / second 345 (: ID!): SingleEnvironmentTask 346 347 # [*Internal use only*] 348 # Query questions by sourceName. 349 # 350 # - Cost complexity: 1 351 # - Rate limit: 10 requests / second 352 (: String!): [CommonTask] 353 354 # Query a filesystem question by ID. Works for all filesystem question types 355 # (free-filesystem, scorable-filesystem, and AI-checker variants). 356 # 357 # - Cost complexity: 1 358 # - Rate limit: 10 requests / second 359 (: ID!): FilesystemTask 360 361 }
link Required by
This element is not required by anyone