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