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 (: ID!, : Int, : Int): [CompanyTestSession]! 115 116 # Query a standardized test session by ID. 117 # 118 # - Cost complexity: 2 119 # - Rate limit: 10 requests / second 120 # 121 # Arguments 122 # id: The ID of the standardized test session to return. 123 (: ID!): StandardizedTestSession 124 125 # Query all roles available to a company 126 # 127 # - Cost complexity: 2 128 # - Rate limit: 5 requests / second 129 # 130 # Arguments 131 # companyId: The ID of the company. 132 (: ID): [Role] 133 134 # [*Internal use only*] 135 # Query all system roles. 136 # 137 # - Cost complexity: 2 138 # - Rate limit: 5 requests / second 139 : [Role] 140 141 # Query a specific role by key. 142 # 143 # - Cost complexity: 1 144 # - Rate limit: 10 requests / second 145 (: ID!): Role 146 147 # Query a company test by ID. 148 # 149 # - Cost complexity: 1 150 # - Rate limit: 10 requests / second 151 # 152 # Arguments 153 # id: The ID of the company test to return. 154 (: ID!): CompanyTest 155 156 # Query company tests for a given company. 157 # 158 # - Cost complexity: 1 x first 159 # - Rate limit: 10 requests / second 160 # 161 # Arguments 162 # companyId: If omitted, will default to the ID of the company 163 # associated with the API consumer. 164 # first: Use 'first' and 'offset' arguments to limit results 165 # returned 166 # ids: Filter by specific test IDs. Only tests with matching IDs 167 # will be returned. 168 # titleSearchText: Search tests by title. Case-insensitive 169 # partial match. 170 # labels: Filter tests by labels. Only tests that have all 171 # specified labels will be returned. 172 # sortBy: The field to sort results by. Defaults to 'title'. 173 # sortDirection: The direction to sort results. Defaults to 174 # 'asc'. 175 ( 176 : ID, 177 : Int!, 178 : Int, 179 : [ID!], 180 : String, 181 : [String!], 182 : CompanyTestSortBy, 183 : SortDirection 184 ): CompanyTests! 185 186 # Query certification tests available for your company. 187 # 188 # - Cost complexity: 1 x first 189 # - Rate limit: 10 requests / second 190 # 191 # Arguments 192 # companyId: If omitted, will default to the ID of the company 193 # associated with the API consumer. 194 # first: Use 'first' and 'offset' arguments to limit results 195 # returned 196 (: ID, : Int!, : Int): CertificationTests! 197 198 # Query a standardized test by ID. 199 # 200 # - Cost complexity: 1 201 # - Rate limit: 10 requests / second 202 # 203 # Arguments 204 # id: The ID of the test to return. 205 (: ID!): StandardizedTest 206 207 # Query a live interview by ID. 208 # 209 # - Cost complexity: 1 210 # - Rate limit: 10 requests / second 211 # 212 # Arguments 213 # liveInterviewId: The ID of the live interview. 214 (: ID!): LiveInterview 215 216 # Query all live interviews optionally filtered by candidate email. 217 # 218 # - Cost complexity: 1 x first 219 # - Rate limit: 10 requests / second 220 # 221 # Arguments 222 # candidateEmail: Email of the candidate associated with the 223 # interview. 224 # first: Use 'first' and 'offset' arguments to limit results 225 # returned. 226 (: String, : Int, : Int): [LiveInterview]! 227 228 # [*Internal use only*] 229 # Performs an access check for the current user or API key. 230 # 231 # - Cost complexity: 1 232 # - Rate limit: 10 requests / second 233 # 234 # Arguments 235 # type: The type of access being checked. 236 # resourceId: The identifier of the resource related to the 237 # access check, if a single ID is required. 238 # resourceIds: The identifiers of the multiple resources related 239 # to the access check, if required. 240 (: AccessType!, : ID, : [ID]): Boolean 241 242 # [*Internal use only*] 243 # Performs multiple access checks for the current user or API key. Using hasAccess 244 # is preferable due to simplicity and 245 # better support for client-side caching of results, but hasAccessList can be used 246 # when the number of queries is variable 247 # and not known in advance. 248 # 249 # - Cost complexity: 2 250 # - Rate limit: 5 requests / second 251 (: [AccessQueryInput!]!): [AccessQueryResult] 252 253 # Query test labels for a company. 254 # 255 # Returns test labels that can be applied to assessments, with optional search 256 # filtering. 257 # 258 # - Cost complexity: 1 x first 259 # - Rate limit: 10 requests / second 260 # 261 # Arguments 262 # companyId: The ID of the company to query test labels for. 263 # If omitted, will default to the ID of the company associated with the API 264 # consumer. 265 # searchText: Optional search string for partial match filtering 266 # on label titles. 267 # The search is case-insensitive. 268 # first: Maximum number of results to return. Required. 269 # offset: Number of results to skip for pagination. 270 (: ID, : String, : Int!, : Int): TestLabels! 271 272 # Returns user either by ID or by username. Exactly one field (either userId or 273 # username) is required. 274 # 275 # - Rate limit: 10 requests / second 276 # 277 # Arguments 278 # userId: Unique user ID. 279 # username: Username unique for each user. 280 (: ID, : String): User 281 282 # Query a question level by question level ID. 283 # 284 # - Cost complexity: 1 285 # - Rate limit: 10 requests / second 286 (: ID!): TaskLevel 287 288 # Query a question by ID. 289 # 290 # - Cost complexity: 1 291 # - Rate limit: 10 requests / second 292 (: ID!): SingleEnvironmentTask 293 294 # [*Internal use only*] 295 # Query questions by sourceName. 296 # 297 # - Cost complexity: 1 298 # - Rate limit: 10 requests / second 299 (: String!): [CommonTask] 300 301 }
link Required by
This element is not required by anyone