OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Query a task by ID. 4 # 5 # - Cost complexity: 1 6 # - Rate limit: 10 requests / second 7 (: ID!): Task 8 9 # Query a company by ID. 10 # 11 # Arguments 12 # id: The ID of the company to return. If omitted, will default 13 # to the ID of the company associated with the API consumer. 14 # 15 # - Cost complexity: 1 16 # - Rate limit: 10 requests / second 17 (: ID): Company 18 19 # [*Internal use only*] 20 # Query all companies. 21 # 22 # - Cost complexity: 3 23 # - Rate limit: 5 requests / second 24 : [Company] 25 26 # [*Internal use only*] 27 # Query all company features. 28 # 29 # - Cost complexity: 2 30 # - Rate limit: 5 requests / second 31 : [CompanyFeature] 32 33 # Query a company test by ID. 34 # 35 # - Cost complexity: 1 36 # - Rate limit: 10 requests / second 37 # 38 # Arguments 39 # id: The ID of the company test to return. 40 (: ID!): CompanyTest 41 42 # Query company tests for a given company. 43 # 44 # - Cost complexity: 1 x first 45 # - Rate limit: 10 requests / second 46 # 47 # Arguments 48 # companyId: If omitted, will default to the ID of the company 49 # associated with the API consumer. 50 # first: Use 'first' and 'offset' arguments to limit results 51 # returned 52 (: ID, : Int!, : Int): CompanyTests! 53 54 # Query a company test session by ID. 55 # 56 # - Cost complexity: 1 57 # - Rate limit: 10 requests / second 58 # 59 # Arguments 60 # id: The ID of the company test session to return. 61 (: ID!): CompanyTestSession 62 63 # Query all company test sessions associated with a given company test ID. 64 # 65 # - Cost complexity: 1 x first 66 # - Rate limit: 10 requests / second 67 # 68 # Arguments 69 # companyTestId: The ID of the company test whose sessions should 70 # be returned. 71 # first: Use 'first' and 'offset' arguments to limit results 72 # returned 73 (: ID!, : Int, : Int): [CompanyTestSession]! 74 75 # Query a standardized test session by ID. 76 # 77 # - Cost complexity: 1 78 # - Rate limit: 10 requests / second 79 # 80 # Arguments 81 # id: The ID of the standardized test session to return. 82 (: ID!): StandardizedTestSession 83 84 # Query a live interview by ID. 85 # 86 # - Cost complexity: 1 87 # - Rate limit: 10 requests / second 88 # 89 # Arguments 90 # liveInterviewId: The ID of the live interview. 91 (: ID!): LiveInterview 92 93 # Query all live interviews associated with a given candidate email. 94 # 95 # - Cost complexity: 1 x first 96 # - Rate limit: 10 requests / second 97 # 98 # Arguments 99 # candidateEmail: Email of the candidate associated with the 100 # interivew. 101 # first: Use 'first' and 'offset' arguments to limit results 102 # returned. 103 (: String!, : Int, : Int): [LiveInterview]! 104 105 # Query an interview template by ID. 106 # 107 # - Cost complexity: 1 108 # - Rate limit: 10 requests / second 109 # 110 # Arguments 111 # interviewTemplateId: The ID of the interview template. 112 (: ID!): InterviewTemplate 113 114 # Query all interview templates of a company. 115 # 116 # - Cost complexity: 1 x first 117 # - Rate limit: 10 requests / second 118 # 119 # Arguments 120 # companyId: The ID of the company. 121 # globalFilter: Search by template name 122 # first: Use 'first' and 'offset' arguments to limit results 123 # returned. 124 ( 125 : ID, 126 : String, 127 : Int!, 128 : Int! 129 ): InterviewTemplates 130 131 # [*Internal use only*] 132 # Query all system roles. 133 # 134 # - Cost complexity: 2 135 # - Rate limit: 5 requests / second 136 : [Role] 137 138 # Query a specific role by key. 139 # 140 # - Cost complexity: 1 141 # - Rate limit: 10 requests / second 142 (: ID!): Role 143 144 # [*Internal use only*] 145 # Query all service plans filtered by the given parameters. 146 # 147 # - Cost complexity: 2 148 # - Rate limit: 5 requests / second 149 # 150 # Arguments 151 # products: Array of CodeSignal assessment products. 152 # types: Array of plan types. 153 # statuses: Array of plan statuses. 154 ( 155 : [Product], 156 : [PlanType], 157 : [ServicePlanStatus] 158 ): [ServicePlan] 159 160 # Query a standardized test by ID. 161 # 162 # - Cost complexity: 1 163 # - Rate limit: 10 requests / second 164 # 165 # Arguments 166 # id: The ID of the test to return. 167 (: ID!): StandardizedTest 168 169 # Returns user either by ID or by username. Exactly one field (either userId or 170 # username) is required. 171 # 172 # - Rate limit: 10 requests / second 173 # 174 # Arguments 175 # userId: Unique user ID. 176 # username: Username unique for each user. 177 (: ID, : String): User 178 179 # [*Internal use only*] 180 # Performs an access check for the current user or API key. 181 # 182 # - Cost complexity: 1 183 # - Rate limit: 10 requests / second 184 # 185 # Arguments 186 # type: The type of access being checked. 187 # resourceId: The identifier of the resource related to the 188 # access check, if a single ID is required. 189 # resourceIds: The identifiers of the multiple resources related 190 # to the access check, if required. 191 (: AccessType!, : ID, : [ID]): Boolean 192 193 # [*Internal use only*] 194 # Performs multiple access checks for the current user or API key. Using hasAccess 195 # is preferable due to simplicity and 196 # better support for client-side caching of results, but hasAccessList can be used 197 # when the number of queries is variable 198 # and not known in advance. 199 # 200 # - Cost complexity: 2 201 # - Rate limit: 5 requests / second 202 (: [AccessQueryInput]!): [AccessQueryResult] 203 204 # Given the input, returns the corresponding certification request. There are 205 # three ways to query for the request: 206 # * by unique request ID; 207 # * by candidate email and test ID (your company ID will be used implicitly); 208 # * by candidate email, test ID and company ID. 209 # 210 # - Cost complexity: 1 211 # - Rate limit: 10 requests / second 212 ( 213 : CertificationRequestInput! 214 ): CertificationRequest 215 216 }
link Required by
This element is not required by anyone