Apollo.io (API)
Try for free
3 days trial then $12.00/month - No credit card required now
Go to Store
Apollo.io (API)
canadesk/apollo-io-api
Try for free
3 days trial then $12.00/month - No credit card required now
Search and enrich People or Organizations (with Job postings). It's fast and costs little.
You can access the Apollo.io (API) programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "2.0",
5 "x-build-id": "hUHfZenBdZu7brFEc"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/canadesk~apollo-io-api/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-canadesk-apollo-io-api",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/canadesk~apollo-io-api/runs": {
50 "post": {
51 "operationId": "runs-sync-canadesk-apollo-io-api",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/canadesk~apollo-io-api/run-sync": {
93 "post": {
94 "operationId": "run-sync-canadesk-apollo-io-api",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "process",
135 "queries",
136 "apiKey",
137 "minutelimit",
138 "hourlimit",
139 "daylimit"
140 ],
141 "properties": {
142 "apiKey": {
143 "title": "API Key",
144 "type": "string",
145 "description": "Required. Available at https://developer.apollo.io/usage/. See Information tab!",
146 "default": ""
147 },
148 "process": {
149 "title": "Process",
150 "enum": [
151 "se",
152 "so",
153 "ep",
154 "eop"
155 ],
156 "type": "string",
157 "description": "Process to run.",
158 "default": "se"
159 },
160 "queries": {
161 "title": "Filters",
162 "type": "array",
163 "description": "See Information tab!"
164 },
165 "mode": {
166 "title": "Search mode",
167 "enum": [
168 "search",
169 "enrich",
170 "jobs"
171 ],
172 "type": "string",
173 "description": "",
174 "default": "search"
175 },
176 "emode": {
177 "title": "Enrichment mode (People)",
178 "enum": [
179 "default",
180 "email",
181 "phone"
182 ],
183 "type": "string",
184 "description": "",
185 "default": "default"
186 },
187 "webhook": {
188 "title": "Webhook URL",
189 "type": "string",
190 "description": "For Reveal phone. See Information tab.",
191 "default": ""
192 },
193 "maximum": {
194 "title": "Maximum results",
195 "minimum": 1,
196 "maximum": 50000,
197 "type": "integer",
198 "description": "Limited by your Apollo plan! See Information tab.",
199 "default": 10
200 },
201 "minutelimit": {
202 "title": "Your Plan - Minute limit",
203 "minimum": 50,
204 "type": "integer",
205 "description": "Enter your minute limit from https://developer.apollo.io/usage/.",
206 "default": 50
207 },
208 "hourlimit": {
209 "title": "Your Plan - Hourly limit",
210 "minimum": 200,
211 "type": "integer",
212 "description": "Enter your hourly limit from https://developer.apollo.io/usage/.",
213 "default": 200
214 },
215 "daylimit": {
216 "title": "Your Plan - Daily limit",
217 "minimum": 600,
218 "type": "integer",
219 "description": "Enter your daily limit from https://developer.apollo.io/usage/.",
220 "default": 600
221 },
222 "stoplimit": {
223 "title": "Stop on limit",
224 "enum": [
225 "yes",
226 "no"
227 ],
228 "type": "string",
229 "description": "Will stop the run when the rate limit is approaching.",
230 "default": "no"
231 },
232 "format": {
233 "title": "Save on usage costs",
234 "enum": [
235 "expanded",
236 "wrapped"
237 ],
238 "type": "string",
239 "description": "See Information tab.",
240 "default": "expanded"
241 },
242 "proxy": {
243 "title": "Proxy configuration",
244 "type": "object",
245 "description": "Select proxies to be used by your crawler."
246 }
247 }
248 },
249 "runsResponseSchema": {
250 "type": "object",
251 "properties": {
252 "data": {
253 "type": "object",
254 "properties": {
255 "id": {
256 "type": "string"
257 },
258 "actId": {
259 "type": "string"
260 },
261 "userId": {
262 "type": "string"
263 },
264 "startedAt": {
265 "type": "string",
266 "format": "date-time",
267 "example": "2025-01-08T00:00:00.000Z"
268 },
269 "finishedAt": {
270 "type": "string",
271 "format": "date-time",
272 "example": "2025-01-08T00:00:00.000Z"
273 },
274 "status": {
275 "type": "string",
276 "example": "READY"
277 },
278 "meta": {
279 "type": "object",
280 "properties": {
281 "origin": {
282 "type": "string",
283 "example": "API"
284 },
285 "userAgent": {
286 "type": "string"
287 }
288 }
289 },
290 "stats": {
291 "type": "object",
292 "properties": {
293 "inputBodyLen": {
294 "type": "integer",
295 "example": 2000
296 },
297 "rebootCount": {
298 "type": "integer",
299 "example": 0
300 },
301 "restartCount": {
302 "type": "integer",
303 "example": 0
304 },
305 "resurrectCount": {
306 "type": "integer",
307 "example": 0
308 },
309 "computeUnits": {
310 "type": "integer",
311 "example": 0
312 }
313 }
314 },
315 "options": {
316 "type": "object",
317 "properties": {
318 "build": {
319 "type": "string",
320 "example": "latest"
321 },
322 "timeoutSecs": {
323 "type": "integer",
324 "example": 300
325 },
326 "memoryMbytes": {
327 "type": "integer",
328 "example": 1024
329 },
330 "diskMbytes": {
331 "type": "integer",
332 "example": 2048
333 }
334 }
335 },
336 "buildId": {
337 "type": "string"
338 },
339 "defaultKeyValueStoreId": {
340 "type": "string"
341 },
342 "defaultDatasetId": {
343 "type": "string"
344 },
345 "defaultRequestQueueId": {
346 "type": "string"
347 },
348 "buildNumber": {
349 "type": "string",
350 "example": "1.0.0"
351 },
352 "containerUrl": {
353 "type": "string"
354 },
355 "usage": {
356 "type": "object",
357 "properties": {
358 "ACTOR_COMPUTE_UNITS": {
359 "type": "integer",
360 "example": 0
361 },
362 "DATASET_READS": {
363 "type": "integer",
364 "example": 0
365 },
366 "DATASET_WRITES": {
367 "type": "integer",
368 "example": 0
369 },
370 "KEY_VALUE_STORE_READS": {
371 "type": "integer",
372 "example": 0
373 },
374 "KEY_VALUE_STORE_WRITES": {
375 "type": "integer",
376 "example": 1
377 },
378 "KEY_VALUE_STORE_LISTS": {
379 "type": "integer",
380 "example": 0
381 },
382 "REQUEST_QUEUE_READS": {
383 "type": "integer",
384 "example": 0
385 },
386 "REQUEST_QUEUE_WRITES": {
387 "type": "integer",
388 "example": 0
389 },
390 "DATA_TRANSFER_INTERNAL_GBYTES": {
391 "type": "integer",
392 "example": 0
393 },
394 "DATA_TRANSFER_EXTERNAL_GBYTES": {
395 "type": "integer",
396 "example": 0
397 },
398 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
399 "type": "integer",
400 "example": 0
401 },
402 "PROXY_SERPS": {
403 "type": "integer",
404 "example": 0
405 }
406 }
407 },
408 "usageTotalUsd": {
409 "type": "number",
410 "example": 0.00005
411 },
412 "usageUsd": {
413 "type": "object",
414 "properties": {
415 "ACTOR_COMPUTE_UNITS": {
416 "type": "integer",
417 "example": 0
418 },
419 "DATASET_READS": {
420 "type": "integer",
421 "example": 0
422 },
423 "DATASET_WRITES": {
424 "type": "integer",
425 "example": 0
426 },
427 "KEY_VALUE_STORE_READS": {
428 "type": "integer",
429 "example": 0
430 },
431 "KEY_VALUE_STORE_WRITES": {
432 "type": "number",
433 "example": 0.00005
434 },
435 "KEY_VALUE_STORE_LISTS": {
436 "type": "integer",
437 "example": 0
438 },
439 "REQUEST_QUEUE_READS": {
440 "type": "integer",
441 "example": 0
442 },
443 "REQUEST_QUEUE_WRITES": {
444 "type": "integer",
445 "example": 0
446 },
447 "DATA_TRANSFER_INTERNAL_GBYTES": {
448 "type": "integer",
449 "example": 0
450 },
451 "DATA_TRANSFER_EXTERNAL_GBYTES": {
452 "type": "integer",
453 "example": 0
454 },
455 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
456 "type": "integer",
457 "example": 0
458 },
459 "PROXY_SERPS": {
460 "type": "integer",
461 "example": 0
462 }
463 }
464 }
465 }
466 }
467 }
468 }
469 }
470 }
471}Apollo.io (API) OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Apollo.io (API) from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Developer
Canadesk SupportMaintained by Community
Actor Metrics
5 monthly users
-
1 star
>99% runs succeeded
Created in Jan 2025
Modified 11 days ago
Categories
