@puppi/adapter-apollo 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2977 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export type paths = {
6
+ "/people/match": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ get?: never;
14
+ put?: never;
15
+ /**
16
+ * People enrichment
17
+ * @description <table>
18
+ * <thead>
19
+ * <tr style="background-color :#FEFFD9; color:#000000">
20
+ * <th colspan="2" align="left">Endpoint essentials</th>
21
+ * </tr>
22
+ * </thead>
23
+ * <tbody>
24
+ * <tr>
25
+ * <td><strong>API key access</strong></td>
26
+ * <td><code>api/v1/people/match</code> or <code>Master API key</code></td>
27
+ * </tr>
28
+ * <tr>
29
+ * <td><strong>OAuth scopes</strong></td>
30
+ * <td><code>people_match</code></td>
31
+ * </tr>
32
+ * <tr>
33
+ * <td><strong>Free account access</strong></td>
34
+ * <td>Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.</td>
35
+ * </tr>
36
+ * <tr>
37
+ * <td><strong>Credit usage</strong></td>
38
+ * <td><code>1–9 credits per person</code> without waterfall enrichment</td>
39
+ * </tr>
40
+ * <tr>
41
+ * <td colspan="2">
42
+ * Credits are charged only if credit-consuming data is found: 1 credit for demographics or email, plus 8 credits if a mobile phone is returned. If no credit-consuming data is found, the request consumes 0 credits. Demographic credit usage depends on `match_confidence`. Apollo doesn't charge a demographic credit when `match_confidence` is `none`. When `match_confidence` is `low`, Apollo charges a demographic credit only if it returns data you didn't send. Email and mobile phone credit usage isn't determined by `match_confidence`. Learn more about <a href="https://docs.apollo.io/docs/api-pricing">API pricing and credits</a>.<br><br>If waterfall enrichment is used for phone or email, credit usage depends on the returned data and the vendors included in your <a href="https://knowledge.apollo.io/hc/en-us/articles/34071121664781-Use-Waterfall-Enrichment">waterfall enrichment configuration</a>; some vendors consume credits per lookup even when no data is found.
43
+ * </td>
44
+ * </tr>
45
+ * </tbody>
46
+ * </table>
47
+ *
48
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the people enrichment endpoint to enrich data for one person. To enrich data for up to ten people with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-people-enrichment">bulk people enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a `200` response, but the response indicates that no records have been enriched. Check `match_confidence` in the response to understand how confidently Apollo matched the submitted information:
49
+ *
50
+ * - `high`: Apollo found a high-confidence match for the submitted person information.
51
+ * - `medium`: Apollo identified a likely match with medium confidence.
52
+ * - `low`: Apollo identified a possible match with low confidence.
53
+ * - `none`: Apollo couldn't find a match for the submitted person information.
54
+ *
55
+ * By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers. When you use `reveal_phone_number`, provide a valid `webhook_url` so Apollo can deliver completed phone enrichment results. Alternatively, set `poll_only=true` and [poll webhook results](ref:poll-webhook-result) with the top-level `request_id_str`. Poll only when `phone_enrichment.status` is `pending`. Do not use `phone_enrichment.request_id`. If the status is `skipped` or `not_attempted`, Apollo did not create a phone enrichment job and polling returns `404 request_id_unknown`.
56
+ *
57
+ * Webhook requirements:
58
+ *
59
+ * - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS.
60
+ *
61
+ * - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.
62
+ *
63
+ * - **Idempotency:** Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.
64
+ *
65
+ * Apollo returns the main enrichment response synchronously, then sends the requested phone numbers to the [webhook asynchronously](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response) or makes them available to poll, depending on your request. For a pending phone enrichment request, [poll webhook results](ref:poll-webhook-result) with the top-level `request_id_str` from the people enrichment response.
66
+ *
67
+ * You can also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When your request includes a waterfall parameter, provide a valid `webhook_url`. Alternatively, set `poll_only=true` and [poll webhook result](ref:poll-webhook-result) with the top-level `request_id_str` returned by the response. Passing `poll_only=true` together with `webhook_url` returns a `400` error (`WEBHOOK_URL_WITH_POLL_ONLY`). Apollo then returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails or phone numbers asynchronously to the [configured webhook](doc:enrich-phone-and-email-using-data-waterfall#asynchronous-webhook-response-1) or makes them available to poll, depending on your request.
68
+ */
69
+ post: operations["people-enrichment"];
70
+ delete?: never;
71
+ options?: never;
72
+ head?: never;
73
+ patch?: never;
74
+ trace?: never;
75
+ };
76
+ "/people/bulk_match": {
77
+ parameters: {
78
+ query?: never;
79
+ header?: never;
80
+ path?: never;
81
+ cookie?: never;
82
+ };
83
+ get?: never;
84
+ put?: never;
85
+ /**
86
+ * Bulk people enrichment
87
+ * @description <table>
88
+ * <thead>
89
+ * <tr style="background-color :#FEFFD9; color:#000000">
90
+ * <th colspan="2" align="left">Endpoint essentials</th>
91
+ * </tr>
92
+ * </thead>
93
+ * <tbody>
94
+ * <tr>
95
+ * <td><strong>API key access</strong></td>
96
+ * <td><code>api/v1/people/bulk_match</code> or <code>Master API key</code></td>
97
+ * </tr>
98
+ * <tr>
99
+ * <td><strong>OAuth scopes</strong></td>
100
+ * <td><code>people_bulk_match</code></td>
101
+ * </tr>
102
+ * <tr>
103
+ * <td><strong>Free account access</strong></td>
104
+ * <td>Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.</td>
105
+ * </tr>
106
+ * <tr>
107
+ * <td><strong>Credit usage</strong></td>
108
+ * <td><code>1–9 credits per person</code> without waterfall enrichment</td>
109
+ * </tr>
110
+ * <tr>
111
+ * <td colspan="2">
112
+ * Credits are charged only if credit-consuming data is found: 1 credit for demographics or email, plus 8 credits if a mobile phone is returned. If no credit-consuming data is found, the request consumes 0 credits. Apollo doesn't charge a demographic credit when it can't match a person. With waterfall enrichment, this is indicated by `match_confidence: none`; for standard requests, unmatched people are returned as `null`. When `match_confidence` is `low`, Apollo charges a demographic credit only if it returns data you didn't send. You can enrich up to 10 people per request. Learn more about <a href="https://docs.apollo.io/docs/api-pricing">API pricing and credits</a>.<br><br>If waterfall enrichment is used for phone or email, credit usage depends on the returned data and the vendors included in your <a href="https://knowledge.apollo.io/hc/en-us/articles/34071121664781-Use-Waterfall-Enrichment">waterfall enrichment configuration</a>; some vendors consume credits per lookup even when no data is found.
113
+ * </td>
114
+ * </tr>
115
+ * </tbody>
116
+ * </table>
117
+ *
118
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.
119
+ *
120
+ * Use the bulk people enrichment endpoint to enrich data for up to ten people with a single API call. To enrich data for a single person, use the <a href="https://docs.apollo.io/reference/people-enrichment">people enrichment endpoint</a> instead.
121
+ *
122
+ * Apollo relies on the information you pass via the endpoint's parameters to identify the correct people to enrich. The details for each person should be passed as an object in the `details[]` array. When you provide more information, Apollo is more likely to find matches within its database. If you only provide general information, such as a name without a domain or email address, you may receive a `200` response, but the response indicates that no records have been enriched. Check `match_confidence` in the response to understand how confidently Apollo matched the submitted information:
123
+ *
124
+ * - `high`: Apollo found a high-confidence match for the submitted person information.
125
+ * - `medium`: Apollo identified a likely match with medium confidence.
126
+ * - `low`: Apollo identified a possible match with low confidence.
127
+ * - `none`: Apollo couldn't find a match for the submitted person information.
128
+ *
129
+ * For standard requests, unmatched entries are returned as `null`. When you use waterfall enrichment, an unmatched result can return `match_confidence: none`.
130
+ *
131
+ * By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers. If you set either of these parameters to `true`, Apollo attempts to provide emails or phone numbers for all matches. When you use `reveal_phone_number`, provide a valid `webhook_url` so Apollo can deliver completed phone enrichment results. Alternatively, set `poll_only=true` and [poll webhook results](ref:poll-webhook-result) with the top-level `request_id_str`. Poll only when `phone_enrichment.status` is `pending`. Do not use `phone_enrichment.request_id`. If the status is `skipped` or `not_attempted`, Apollo did not create a phone enrichment job and polling returns `404 request_id_unknown`.
132
+ *
133
+ * Webhook requirements:
134
+ *
135
+ * - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS.
136
+ *
137
+ * - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.
138
+ *
139
+ * - **Idempotency:** Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.
140
+ *
141
+ * You can also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When your request includes a waterfall parameter, provide a valid `webhook_url`. Alternatively, set `poll_only=true` and [poll webhook result](ref:poll-webhook-result) with the top-level `request_id_str` returned by the response. Passing `poll_only=true` together with `webhook_url` returns a `400` error (`WEBHOOK_URL_WITH_POLL_ONLY`). Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Completed emails or phone numbers are delivered asynchronously to your [configured webhook](doc:enrich-phone-and-email-using-data-waterfall#asynchronous-webhook-response-1) or made available to poll, depending on your request.
142
+ */
143
+ post: operations["bulk-people-enrichment"];
144
+ delete?: never;
145
+ options?: never;
146
+ head?: never;
147
+ patch?: never;
148
+ trace?: never;
149
+ };
150
+ "/organizations/enrich": {
151
+ parameters: {
152
+ query?: never;
153
+ header?: never;
154
+ path?: never;
155
+ cookie?: never;
156
+ };
157
+ /**
158
+ * Organization enrichment
159
+ * @description ## Endpoint essentials
160
+ *
161
+ * **API key access:** `api/v1/organizations/enrich` or `Master API key`
162
+ *
163
+ * **OAuth scopes:** `organizations_enrich`
164
+ *
165
+ * **Free account access:** Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.
166
+ *
167
+ * **Credit usage:** `1 credit per organization` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).
168
+ *
169
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the organization enrichment endpoint to enrich data for one company. To enrich data for up to ten companies with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-organization-enrichment">bulk organization enrichment endpoint</a> instead.<br><br>Identify a company using its domain, LinkedIn URL, or website. You can include its name to improve match accuracy, but name alone is not supported.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, corporate phone numbers, locations, language counts, retail-location counts, and organization hierarchy data. The <code>owned_by_organization</code> field identifies the immediate parent, <code>owned_by_chain</code> lists parent organization IDs from the immediate parent to the ultimate parent, and <code>ultimate_parent_organization</code> identifies the topmost parent. The <code>suborganizations</code> array includes each direct subsidiary's industries, estimated employee count, and country when available.
170
+ */
171
+ get: operations["organization-enrichment"];
172
+ put?: never;
173
+ post?: never;
174
+ delete?: never;
175
+ options?: never;
176
+ head?: never;
177
+ patch?: never;
178
+ trace?: never;
179
+ };
180
+ "/organizations/bulk_enrich": {
181
+ parameters: {
182
+ query?: never;
183
+ header?: never;
184
+ path?: never;
185
+ cookie?: never;
186
+ };
187
+ get?: never;
188
+ put?: never;
189
+ /**
190
+ * Bulk organization enrichment
191
+ * @description ## Endpoint essentials
192
+ *
193
+ * **API key access:** `api/v1/organizations/bulk_enrich` or `Master API key`
194
+ *
195
+ * **OAuth scopes:** `organizations_bulk_enrich`
196
+ *
197
+ * **Free account access:** Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.
198
+ *
199
+ * **Credit usage:** `1 credit per organization` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).
200
+ *
201
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the bulk organization enrichment endpoint to enrich data for up to ten companies with a single API call. To enrich data for a single company, use the <a href="https://docs.apollo.io/reference/organization-enrichment">organization enrichment endpoint</a> instead.<br><br>You can identify the companies to enrich by providing a list of domains via the <code>domains[]</code> query parameter, or by providing a <code>details</code> array in the request body where each company can be matched by any combination of domain, LinkedIn URL, name, and website.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, corporate phone numbers, locations, language counts, retail-location counts, and organization hierarchy data. The <code>owned_by_organization</code> field identifies the immediate parent, <code>owned_by_chain</code> lists parent organization IDs from the immediate parent to the ultimate parent, and <code>ultimate_parent_organization</code> identifies the topmost parent. Each result also includes <code>num_suborganizations</code> and <code>subsidiary_rollups</code> with the total estimated subsidiary employee count and distinct subsidiary countries and industries.
202
+ */
203
+ post: operations["bulk-organization-enrichment"];
204
+ delete?: never;
205
+ options?: never;
206
+ head?: never;
207
+ patch?: never;
208
+ trace?: never;
209
+ };
210
+ "/mixed_people/api_search": {
211
+ parameters: {
212
+ query?: never;
213
+ header?: never;
214
+ path?: never;
215
+ cookie?: never;
216
+ };
217
+ get?: never;
218
+ put?: never;
219
+ /**
220
+ * People API search
221
+ * @description ## Endpoint essentials
222
+ *
223
+ * **API key access:** `api/v1/mixed_people/api_search` or `Master API key`
224
+ *
225
+ * **OAuth scopes:** `mixed_people_api_search`
226
+ *
227
+ * **Free account access:** Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.
228
+ *
229
+ * **Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).
230
+ *
231
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658716941-Search-for-People" target="_blank">People</a> are net-new prospects you haven't yet saved as contacts on Apollo.<br><br>Use the people API search endpoint to find new prospects. Several filters are available to help narrow your search. This endpoint doesn't return email addresses or phone numbers. Use the <a href="https://docs.apollo.io/reference/people-enrichment">people enrichment</a> or <a href="https://docs.apollo.io/reference/bulk-people-enrichment">bulk people enrichment</a> endpoints to enrich data.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
232
+ */
233
+ post: operations["people-api-search"];
234
+ delete?: never;
235
+ options?: never;
236
+ head?: never;
237
+ patch?: never;
238
+ trace?: never;
239
+ };
240
+ "/mixed_companies/search": {
241
+ parameters: {
242
+ query?: never;
243
+ header?: never;
244
+ path?: never;
245
+ cookie?: never;
246
+ };
247
+ get?: never;
248
+ put?: never;
249
+ /**
250
+ * Organization search
251
+ * @description ## Endpoint essentials
252
+ *
253
+ * **API key access:** `api/v1/mixed_companies/search` or `Master API key`
254
+ *
255
+ * **OAuth scopes:** `mixed_companies_search`
256
+ *
257
+ * **Free account access:** Requires an Apollo account registered with a work email address. Additional account eligibility requirements may apply. Paid accounts aren't affected.
258
+ *
259
+ * **Credit usage:** `1 credit per page`
260
+ *
261
+ * This endpoint consumes 1 Apollo credit per page, with up to 100 results per page. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).
262
+ *
263
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the organization search endpoint to find companies in the Apollo database. Several filters are available to help narrow your search.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
264
+ */
265
+ post: operations["organization-search"];
266
+ delete?: never;
267
+ options?: never;
268
+ head?: never;
269
+ patch?: never;
270
+ trace?: never;
271
+ };
272
+ "/users/api_profile": {
273
+ parameters: {
274
+ query?: never;
275
+ header?: never;
276
+ path?: never;
277
+ cookie?: never;
278
+ };
279
+ /**
280
+ * Get current user profile
281
+ * @description ## Endpoint essentials
282
+ *
283
+ * **API key access:** `api/v1/users/api_profile` or `Master API key`
284
+ *
285
+ * **OAuth scopes:** `read_user_profile`
286
+ *
287
+ * **Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).
288
+ *
289
+ * **Authentication note:** Default scope — granted automatically on every OAuth token.
290
+ *
291
+ * <a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the get current user profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.<br><br>By default, the endpoint returns the user's identity fields. Set the `include_credit_usage` query parameter to `true` to also return the user's and team's credit usage and remaining credit balances.<br><br>If you call this endpoint without valid access credentials, you receive a `401` response.
292
+ */
293
+ get: operations["get-current-user-profile"];
294
+ put?: never;
295
+ post?: never;
296
+ delete?: never;
297
+ options?: never;
298
+ head?: never;
299
+ patch?: never;
300
+ trace?: never;
301
+ };
302
+ };
303
+ export type webhooks = Record<string, never>;
304
+ export type components = {
305
+ schemas: {
306
+ /** @description Machine-readable detail for an error that uses the new format, returned alongside the endpoint's existing error fields. The legacy error fields at the root level (`error`, `error_code`, `message`, etc) are removed on 2027-02-16, after which `error_details` is the only error payload. Some errors already return `error_details` on its own. */
307
+ ErrorDetails: {
308
+ /**
309
+ * @description Stable identifier in the form `DOMAIN.CATEGORY.REASON`. Branch on this value; the human-readable `message` can change.
310
+ * @example AUTH.AUTHENTICATION.CREDENTIALS_MISSING
311
+ */
312
+ code?: string;
313
+ /**
314
+ * @description Human-readable explanation of what went wrong.
315
+ * @example This request carried no credential Apollo could authenticate.
316
+ */
317
+ message?: string;
318
+ /** @description Ordered, actionable next steps. Each entry carries a `label`, and where relevant the `parameter`, `header`, or `url` it refers to. */
319
+ suggestions?: {
320
+ /** @example Send your API key in the X-Api-Key header */
321
+ label?: string;
322
+ /** @example https://docs.apollo.io/reference/authentication */
323
+ url?: string;
324
+ /** @example webhook_url */
325
+ parameter?: string;
326
+ /**
327
+ * @description Several parameters, any one of which satisfies the requirement.
328
+ * @example [
329
+ * "name",
330
+ * "domain",
331
+ * "website_url",
332
+ * "linkedin_url"
333
+ * ]
334
+ */
335
+ parameters?: string[];
336
+ /** @example X-Api-Key */
337
+ header?: string;
338
+ /** @description A valid sample value for the parameter named above. */
339
+ example?: string;
340
+ /**
341
+ * @description On a rate-limit refusal, how long to wait before retrying.
342
+ * @example 60
343
+ */
344
+ retry_after_seconds?: number;
345
+ }[];
346
+ /**
347
+ * @description Values from your request that explain the refusal. Each entry is an object rather than a bare value, so read `context.<key>.value`. Absent when the error needs no context.
348
+ * @example {
349
+ * "window": {
350
+ * "value": "hourly",
351
+ * "description": "The rate-limit window your request exceeded"
352
+ * }
353
+ * }
354
+ */
355
+ context?: {
356
+ [key: string]: {
357
+ value?: string | number | string[];
358
+ description?: string;
359
+ };
360
+ };
361
+ };
362
+ };
363
+ responses: never;
364
+ parameters: never;
365
+ requestBodies: never;
366
+ headers: never;
367
+ pathItems: never;
368
+ };
369
+ export type SchemaErrorDetails = components["schemas"]["ErrorDetails"];
370
+ export type $defs = Record<string, never>;
371
+ export interface operations {
372
+ "people-enrichment": {
373
+ parameters: {
374
+ query?: {
375
+ /** @description The first name of the person. This is typically used in combination with the `last_name` parameter. <br><br>Example: `jordan` */
376
+ first_name?: string;
377
+ /** @description The last name of the person. This is typically used in combination with the `first_name` parameter. <br><br>Example: `blake` */
378
+ last_name?: string;
379
+ /** @description The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the `first_name` and `last_name` parameters. <br><br>Example: `jordan blake` */
380
+ name?: string;
381
+ /** @description The email address of the person. <br><br>Example: `jordan@ymail.org` */
382
+ email?: string;
383
+ /** @description The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. <br><br>Example: `8d935115b9ff4489f2d1f9249503cadf` (MD5) or `97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152` (SHA-256) */
384
+ hashed_email?: string;
385
+ /** @description The name of the person's employer. This can be the current employer or a previous employer. <br><br>Example: `northstar analytics` */
386
+ organization_name?: string;
387
+ /** @description The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar. <br><br>Example: `apollo.io` or `microsoft.com` */
388
+ domain?: string;
389
+ /** @description The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. <br><br>To find IDs, call the <a href="https://docs.apollo.io/reference/people-api-search" target="_blank">people API search endpoint</a> and identify the values for `person_id`. <br><br>Example: `587cf802f65125cad923a266` */
390
+ id?: string;
391
+ /** @description The URL for the person's LinkedIn profile. <br><br>Example: `https://www.linkedin.com/in/jordan-blake-4a7c21` */
392
+ linkedin_url?: string;
393
+ /** @description Set to true to enable email waterfall enrichment */
394
+ run_waterfall_email?: boolean;
395
+ /** @description Set to true to enable phone waterfall enrichment */
396
+ run_waterfall_phone?: boolean;
397
+ /** @description Set to `true` if you want to enrich the person's data with personal emails. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is `false`. <br><br>If a person resides in a <a href="https://knowledge.apollo.io/hc/en-us/articles/4409141087757" target="_blank">GDPR</a>-compliant region, Apollo will not reveal their personal email. */
398
+ reveal_personal_emails?: boolean;
399
+ /** @description Set to `true` if you want to enrich the person's data with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is `false`. <br><br>To receive completed phone enrichment results, provide a webhook URL with the `webhook_url` parameter. Alternatively, set `poll_only=true` and omit `webhook_url` to retrieve the result by polling. */
400
+ reveal_phone_number?: boolean;
401
+ /** @description Provide this parameter to receive phone or waterfall enrichment results by webhook. Your webhook URL must be publicly accessible over HTTPS. <br><br>When `poll_only=true`, omit `webhook_url` and retrieve the result by polling instead. <br><br>If phone numbers are not delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL. <br><br>Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610` */
402
+ webhook_url?: string;
403
+ /** @description Set to `true` to receive phone or waterfall enrichment results by polling instead of a webhook. When `poll_only` is `true`, omit `webhook_url` — Apollo returns a `request_id` you can pass to the <a href="https://docs.apollo.io/reference/poll-webhook-result">poll webhook result</a> endpoint to retrieve the result. <br><br>Passing `poll_only=true` together with `webhook_url` returns a `400` error (`WEBHOOK_URL_WITH_POLL_ONLY`). The default value is `false`. */
404
+ poll_only?: boolean;
405
+ };
406
+ header?: never;
407
+ path?: never;
408
+ cookie?: never;
409
+ };
410
+ requestBody?: never;
411
+ responses: {
412
+ /** @description 200 */
413
+ 200: {
414
+ headers: {
415
+ [name: string]: unknown;
416
+ };
417
+ content: {
418
+ "application/json": {
419
+ /**
420
+ * @description The signed 64-bit request ID for the enrichment request.
421
+ * @example 1039995589705121900
422
+ */
423
+ request_id?: number;
424
+ /**
425
+ * @description The exact string representation of the top-level request ID. When `phone_enrichment.status` is `pending`, pass this value unchanged to `GET /api/v1/webhook_result/{request_id}`. Do not pass `phone_enrichment.request_id`.
426
+ * @example -9045486258674686251
427
+ */
428
+ request_id_str?: string;
429
+ person?: {
430
+ /** @example 672c91d4a7be42000184f2c9 */
431
+ id?: string;
432
+ /** @example Jordan */
433
+ first_name?: string;
434
+ /** @example Blake */
435
+ last_name?: string;
436
+ /** @example Jordan Blake */
437
+ name?: string;
438
+ /** @example http://www.linkedin.com/in/jordan-blake-4a7c21 */
439
+ linkedin_url?: string;
440
+ /** @example Founder & CEO */
441
+ title?: string;
442
+ /** @example verified */
443
+ email_status?: string;
444
+ /** @example https://media.licdn.com/dms/image/v2/D5603AQH9vR4tY2wP7k/profile-displayphoto-shrink_200_200 */
445
+ photo_url?: string;
446
+ twitter_url?: unknown;
447
+ github_url?: unknown;
448
+ facebook_url?: unknown;
449
+ extrapolated_email_confidence?: number | null;
450
+ /** @example Founder & CEO at Northstar Analytics */
451
+ headline?: string;
452
+ /** @example jordan.blake@northstaranalytics.io */
453
+ email?: string;
454
+ /** @example 61f2d5a8c40b7200019e4f31 */
455
+ organization_id?: string;
456
+ /**
457
+ * @example high
458
+ * @enum {string}
459
+ */
460
+ match_confidence?: "high" | "medium" | "low" | "none";
461
+ employment_history?: {
462
+ /** @example 672c93a1b8df4e0001f732a1 */
463
+ _id?: string;
464
+ created_at?: unknown;
465
+ /**
466
+ * @default true
467
+ * @example true
468
+ */
469
+ current?: boolean;
470
+ degree?: unknown;
471
+ description?: unknown;
472
+ emails?: unknown;
473
+ end_date?: unknown;
474
+ grade_level?: unknown;
475
+ kind?: unknown;
476
+ major?: unknown;
477
+ /** @example 61f2d5a8c40b7200019e4f31 */
478
+ organization_id?: string;
479
+ /** @example Northstar Analytics */
480
+ organization_name?: string;
481
+ raw_address?: unknown;
482
+ /** @example 2016-01-01 */
483
+ start_date?: string;
484
+ /** @example Founder & CEO */
485
+ title?: string;
486
+ updated_at?: unknown;
487
+ /** @example 672c93a1b8df4e0001f732a1 */
488
+ id?: string;
489
+ /** @example 672c93a1b8df4e0001f732a1 */
490
+ key?: string;
491
+ }[];
492
+ /** @example California */
493
+ state?: string;
494
+ /** @example San Francisco */
495
+ city?: string;
496
+ /** @example United States */
497
+ country?: string;
498
+ /** @example 672c95e2d2f1140001aa4c18 */
499
+ contact_id?: string;
500
+ contact?: {
501
+ contact_roles?: unknown[];
502
+ /** @example 672c95e2d2f1140001aa4c18 */
503
+ id?: string;
504
+ /** @example Casey */
505
+ first_name?: string;
506
+ /** @example Morgan */
507
+ last_name?: string;
508
+ /** @example Casey Morgan */
509
+ name?: string;
510
+ /** @example http://www.linkedin.com/in/jordan-blake-4a7c21 */
511
+ linkedin_url?: string;
512
+ /** @example President */
513
+ title?: string;
514
+ /** @example 61f2da03c40b7200019e4f50 */
515
+ contact_stage_id?: string;
516
+ owner_id?: unknown;
517
+ /** @example 672c9613d2f1140001aa4c22 */
518
+ creator_id?: string;
519
+ /** @example 672c91d4a7be42000184f2c9 */
520
+ person_id?: string;
521
+ email_needs_tickling?: unknown;
522
+ /** @example Northstar Analytics */
523
+ organization_name?: string;
524
+ /** @example crm */
525
+ source?: string;
526
+ /** @example crm */
527
+ original_source?: string;
528
+ /** @example 61f2d5a8c40b7200019e4f31 */
529
+ organization_id?: string;
530
+ /** @example President at Northstar Analytics */
531
+ headline?: string;
532
+ photo_url?: unknown;
533
+ /** @example New York, New York, United States */
534
+ present_raw_address?: string;
535
+ linkedin_uid?: unknown;
536
+ extrapolated_email_confidence?: number | null;
537
+ salesforce_id?: unknown;
538
+ salesforce_lead_id?: unknown;
539
+ salesforce_contact_id?: unknown;
540
+ salesforce_account_id?: unknown;
541
+ crm_owner_id?: unknown;
542
+ /** @example 2024-05-23T20:00:28.527Z */
543
+ created_at?: string;
544
+ emailer_campaign_ids?: unknown[];
545
+ direct_dial_status?: unknown;
546
+ direct_dial_enrichment_failed_at?: unknown;
547
+ /** @example verified */
548
+ email_status?: string;
549
+ email_source?: unknown;
550
+ /** @example 672c964bd2f1140001aa4c2f */
551
+ account_id?: string;
552
+ last_activity_date?: unknown;
553
+ hubspot_vid?: unknown;
554
+ hubspot_company_id?: unknown;
555
+ crm_id?: unknown;
556
+ /** @example +14155550158 */
557
+ sanitized_phone?: string;
558
+ merged_crm_ids?: unknown;
559
+ /** @example 2024-06-02T08:53:51.266Z */
560
+ updated_at?: string;
561
+ queued_for_crm_push?: unknown;
562
+ suggested_from_rule_engine_config_id?: unknown;
563
+ email_unsubscribed?: unknown;
564
+ label_ids?: unknown[];
565
+ /**
566
+ * @default true
567
+ * @example false
568
+ */
569
+ has_pending_email_arcgate_request?: boolean;
570
+ /**
571
+ * @default true
572
+ * @example false
573
+ */
574
+ has_email_arcgate_request?: boolean;
575
+ /** @example invisible */
576
+ existence_level?: string;
577
+ /** @example casey.morgan@northstaranalytics.io */
578
+ email?: string;
579
+ /**
580
+ * @default true
581
+ * @example true
582
+ */
583
+ email_from_customer?: boolean;
584
+ typed_custom_fields?: Record<string, unknown>;
585
+ custom_field_errors?: unknown;
586
+ crm_record_url?: unknown;
587
+ email_status_unavailable_reason?: unknown;
588
+ /** @example Verified */
589
+ email_true_status?: string;
590
+ /**
591
+ * @default true
592
+ * @example false
593
+ */
594
+ updated_email_true_status?: boolean;
595
+ contact_rule_config_statuses?: unknown[];
596
+ /** @example Imported from CRM */
597
+ source_display_name?: string;
598
+ contact_emails?: {
599
+ /** @example casey.morgan@northstaranalytics.io */
600
+ email?: string;
601
+ /** @example 9f3b7c2d481a5e6f0d4c8b1a2e7f9c30 */
602
+ email_md5?: string;
603
+ /** @example a6c79e4f2b310d9581f67ac3e4d89b20174f5c6a9d3e2b810f7c4a56e93d128b */
604
+ email_sha256?: string;
605
+ /** @example verified */
606
+ email_status?: string;
607
+ email_source?: unknown;
608
+ extrapolated_email_confidence?: number | null;
609
+ /**
610
+ * @default 0
611
+ * @example 0
612
+ */
613
+ position?: number;
614
+ email_from_customer?: unknown;
615
+ /**
616
+ * @default true
617
+ * @example false
618
+ */
619
+ free_domain?: boolean;
620
+ }[];
621
+ /** @example America/Los_Angeles */
622
+ time_zone?: string;
623
+ phone_numbers?: {
624
+ /** @example (415) 555-0158 */
625
+ raw_number?: string;
626
+ /** @example +14155550158 */
627
+ sanitized_number?: string;
628
+ type?: unknown;
629
+ /**
630
+ * @default 0
631
+ * @example 0
632
+ */
633
+ position?: number;
634
+ /** @example valid_number */
635
+ status?: string;
636
+ dnc_status?: unknown;
637
+ dnc_other_info?: unknown;
638
+ dialer_flags?: unknown;
639
+ }[];
640
+ account_phone_note?: unknown;
641
+ /**
642
+ * @default true
643
+ * @example false
644
+ */
645
+ free_domain?: boolean;
646
+ /**
647
+ * @default true
648
+ * @example false
649
+ */
650
+ is_likely_to_engage?: boolean;
651
+ };
652
+ /**
653
+ * @default true
654
+ * @example true
655
+ */
656
+ revealed_for_current_team?: boolean;
657
+ organization?: {
658
+ /** @example 61f2d5a8c40b7200019e4f31 */
659
+ id?: string;
660
+ /** @example Northstar Analytics */
661
+ name?: string;
662
+ /** @example https://www.northstaranalytics.io */
663
+ website_url?: string;
664
+ blog_url?: unknown;
665
+ angellist_url?: unknown;
666
+ /** @example https://www.linkedin.com/company/apolloio */
667
+ linkedin_url?: string;
668
+ /** @example https://x.com/useapolloio */
669
+ twitter_url?: string;
670
+ /** @example https://www.facebook.com/example-company */
671
+ facebook_url?: string;
672
+ primary_phone?: Record<string, unknown>;
673
+ languages?: unknown[];
674
+ /**
675
+ * @default 0
676
+ * @example 3514
677
+ */
678
+ alexa_ranking?: number;
679
+ phone?: unknown;
680
+ /** @example 18511550 */
681
+ linkedin_uid?: string;
682
+ /**
683
+ * @default 0
684
+ * @example 2015
685
+ */
686
+ founded_year?: number;
687
+ publicly_traded_symbol?: unknown;
688
+ publicly_traded_exchange?: unknown;
689
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/84acb173f920c1e65a47d920/picture */
690
+ logo_url?: string;
691
+ crunchbase_url?: unknown;
692
+ /** @example northstaranalytics.io */
693
+ primary_domain?: string;
694
+ /** @example information technology & services */
695
+ industry?: string;
696
+ keywords?: string[];
697
+ /**
698
+ * @default 0
699
+ * @example 850
700
+ */
701
+ estimated_num_employees?: number;
702
+ industries?: string[];
703
+ secondary_industries?: unknown[];
704
+ /**
705
+ * @default true
706
+ * @example true
707
+ */
708
+ snippets_loaded?: boolean;
709
+ /** @example 61f2dbc2c40b7200019e4f61 */
710
+ industry_tag_id?: string;
711
+ industry_tag_hash?: {
712
+ /** @example 61f2dbc2c40b7200019e4f61 */
713
+ "information technology & services"?: string;
714
+ };
715
+ /** @description The North American Industry Classification System (NAICS) codes for the company. This field is only included when Apollo has NAICS codes for the company. */
716
+ naics_codes?: string[];
717
+ /** @description The Standard Industrial Classification (SIC) codes for the company. This field is only included when Apollo has SIC codes for the company. */
718
+ sic_codes?: string[];
719
+ /**
720
+ * @default 0
721
+ * @example 0
722
+ */
723
+ retail_location_count?: number;
724
+ /** @example 220 Market St, Floor 12, San Francisco, California 94105, US */
725
+ raw_address?: string;
726
+ /** @example 415 Mission St */
727
+ street_address?: string;
728
+ /** @example San Francisco */
729
+ city?: string;
730
+ /** @example California */
731
+ state?: string;
732
+ /** @example 94105-2301 */
733
+ postal_code?: string;
734
+ /** @example United States */
735
+ country?: string;
736
+ owned_by_organization_id?: unknown;
737
+ /** @example Northstar Analytics provides sales intelligence and engagement software for modern revenue teams. */
738
+ seo_description?: string;
739
+ /**
740
+ * @example Northstar Analytics combines business data, sales engagement, and automation tools in one platform. Revenue teams use Northstar Analytics to identify prospective buyers, personalize outreach, and manage sales workflows at scale.
741
+ *
742
+ * The company serves customers across software, financial services, and professional services.
743
+ */
744
+ short_description?: string;
745
+ suborganizations?: unknown[];
746
+ /**
747
+ * @default 0
748
+ * @example 0
749
+ */
750
+ num_suborganizations?: number;
751
+ /** @example 85M */
752
+ annual_revenue_printed?: string;
753
+ /**
754
+ * @default 0
755
+ * @example 85000000
756
+ */
757
+ annual_revenue?: number;
758
+ /**
759
+ * @default 0
760
+ * @example 142000000
761
+ */
762
+ total_funding?: number;
763
+ /** @example 142M */
764
+ total_funding_printed?: string;
765
+ /** @example 2023-08-01T00:00:00.000+00:00 */
766
+ latest_funding_round_date?: string;
767
+ /** @example Series D */
768
+ latest_funding_stage?: string;
769
+ funding_events?: {
770
+ /** @example 672c978cd2f1140001aa4c51 */
771
+ id?: string;
772
+ /** @example 2023-08-01T00:00:00.000+00:00 */
773
+ date?: string;
774
+ news_url?: unknown;
775
+ /** @example Series D */
776
+ type?: string;
777
+ /** @example Crestline Ventures, Summit Ridge Capital, Harbor Peak Ventures, Northgate Ventures */
778
+ investors?: string;
779
+ /** @example 85M */
780
+ amount?: string;
781
+ /** @example $ */
782
+ currency?: string;
783
+ }[];
784
+ technology_names?: string[];
785
+ current_technologies?: {
786
+ /** @example ai */
787
+ uid?: string;
788
+ /** @example AI */
789
+ name?: string;
790
+ /** @example Other */
791
+ category?: string;
792
+ }[];
793
+ org_chart_root_people_ids?: string[];
794
+ /** @example OrgChart::SectorHierarchy::Rules::IT */
795
+ org_chart_sector?: string;
796
+ /**
797
+ * @default true
798
+ * @example false
799
+ */
800
+ org_chart_removed?: boolean;
801
+ /**
802
+ * @default true
803
+ * @example true
804
+ */
805
+ org_chart_show_department_filter?: boolean;
806
+ };
807
+ /**
808
+ * @default true
809
+ * @example true
810
+ */
811
+ is_likely_to_engage?: boolean;
812
+ /**
813
+ * @default true
814
+ * @example false
815
+ */
816
+ show_intent?: boolean;
817
+ departments?: string[];
818
+ subdepartments?: string[];
819
+ functions?: string[];
820
+ /** @example founder */
821
+ seniority?: string;
822
+ };
823
+ /** @description Returned when you set `reveal_phone_number` to `true`, Apollo matches the submitted person, and you aren't using `run_waterfall_phone`. Phone numbers are enriched asynchronously and delivered to your `webhook_url` or made available to poll when `poll_only=true`.<br><br>If you requested `run_waterfall_phone` instead, phone status is reported through the `waterfall` object. */
824
+ phone_enrichment?: {
825
+ /**
826
+ * @description Internal identifier for the phone enrichment job. Returned only when status is `pending`. Do not pass this value to `GET /api/v1/webhook_result/{request_id}`; use the top-level `request_id_str`.
827
+ * @example 64a7ff0cc4dfae00013df1a5
828
+ */
829
+ request_id?: string;
830
+ /**
831
+ * @description `pending` means Apollo created a phone enrichment request and the result is delivered asynchronously. `skipped` means Apollo did not create a request, such as when direct-dial access is unavailable or phone enrichment is already in progress. `not_attempted` means Apollo did not create a request because the returned person is not a saved Apollo person record. No phone credits are charged for `not_attempted`.
832
+ * @example pending
833
+ * @enum {string}
834
+ */
835
+ status?: "pending" | "skipped" | "not_attempted";
836
+ /**
837
+ * @description A human-readable explanation of the phone enrichment status.
838
+ * @example Phone enrichment is processing asynchronously. Retrieve the result by polling GET /api/v1/webhook_result/{request_id} with the top-level `request_id_str` field from this response.
839
+ */
840
+ message?: string;
841
+ };
842
+ };
843
+ };
844
+ };
845
+ /** @description 400 */
846
+ 400: {
847
+ headers: {
848
+ [name: string]: unknown;
849
+ };
850
+ content: {
851
+ "application/json": {
852
+ /**
853
+ * @deprecated
854
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
855
+ * @example Do not pass 'webhook_url' with poll_only=true
856
+ */
857
+ error?: string;
858
+ error_details?: {
859
+ /** @example SEARCH.VALIDATION.WEBHOOK_URL_WITH_POLL_ONLY */
860
+ code?: string;
861
+ message?: string;
862
+ suggestions?: Record<string, unknown>[];
863
+ context?: Record<string, unknown>;
864
+ };
865
+ };
866
+ };
867
+ };
868
+ /** @description 401 */
869
+ 401: {
870
+ headers: {
871
+ [name: string]: unknown;
872
+ };
873
+ content: {
874
+ "text/plain": unknown;
875
+ };
876
+ };
877
+ /** @description 429 */
878
+ 429: {
879
+ headers: {
880
+ [name: string]: unknown;
881
+ };
882
+ content: {
883
+ "application/json": {
884
+ error_details?: components["schemas"]["ErrorDetails"];
885
+ /**
886
+ * @deprecated
887
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
888
+ * @example The maximum number of api calls allowed for api/v1/people/match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
889
+ */
890
+ message?: string;
891
+ };
892
+ };
893
+ };
894
+ };
895
+ };
896
+ "bulk-people-enrichment": {
897
+ parameters: {
898
+ query?: {
899
+ /** @description Set to true to enable email waterfall enrichment */
900
+ run_waterfall_email?: boolean;
901
+ /** @description Set to true to enable phone waterfall enrichment */
902
+ run_waterfall_phone?: boolean;
903
+ /** @description Set to `true` if you want to enrich all matched people with personal emails. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is `false`. <br><br>If a person resides in a <a href="https://knowledge.apollo.io/hc/en-us/articles/4409141087757" target="_blank">GDPR</a>-compliant region, Apollo will not reveal their personal email. */
904
+ reveal_personal_emails?: boolean;
905
+ /** @description Set to `true` if you want to enrich the data of all matched people with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your <a href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo pricing plan</a>. The default value is `false`. <br><br>To receive completed phone enrichment results, provide a webhook URL with the `webhook_url` parameter. Alternatively, set `poll_only=true` and omit `webhook_url` to retrieve the result by polling. */
906
+ reveal_phone_number?: boolean;
907
+ /** @description Provide this parameter to receive phone or waterfall enrichment results by webhook. Your webhook URL must be publicly accessible over HTTPS. <br><br>When `poll_only=true`, omit `webhook_url` and retrieve the result by polling instead. <br><br>If phone numbers are not delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL. <br><br>Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610` */
908
+ webhook_url?: string;
909
+ /** @description Set to `true` to receive phone or waterfall enrichment results by polling instead of a webhook. When `poll_only` is `true`, omit `webhook_url` — Apollo returns a `request_id` you can pass to the <a href="https://docs.apollo.io/reference/poll-webhook-result">poll webhook result</a> endpoint to retrieve the result. <br><br>Passing `poll_only=true` together with `webhook_url` returns a `400` error (`WEBHOOK_URL_WITH_POLL_ONLY`). The default value is `false`. */
910
+ poll_only?: boolean;
911
+ };
912
+ header?: never;
913
+ path?: never;
914
+ cookie?: never;
915
+ };
916
+ requestBody?: {
917
+ content: {
918
+ "application/json": {
919
+ /** @description Provide info for each person you want to enrich as an object within this array. Add up to 10 people. */
920
+ details: {
921
+ /** @description The first name of the person. This is typically used in combination with the `last_name` parameter. <br><br>Example: `jordan` */
922
+ first_name?: string;
923
+ /** @description The last name of the person. This is typically used in combination with the `first_name` parameter. <br><br>Example: `blake` */
924
+ last_name?: string;
925
+ /** @description The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the `first_name` and `last_name` parameters. <br><br>Example: `jordan blake` */
926
+ name?: string;
927
+ /** @description The email address of the person. <br><br>Example: `jordan@ymail.com` */
928
+ email?: string;
929
+ /** @description The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. <br><br>Example: `6be3e6cc98ff08b43558bc5a198c7144` (MD5) or `97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152` (SHA-256) */
930
+ hashed_email?: string;
931
+ /** @description The name of the person's employer. This can be the current employer or a previous employer. <br><br>Example: `northstar analytics` */
932
+ organization_name?: string;
933
+ /** @description The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar. <br><br>Example: `apollo.io` or `microsoft.com` */
934
+ domain?: string;
935
+ /** @description The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. <br><br>To find IDs, call the <a href="https://docs.apollo.io/reference/people-api-search" target="_blank">people API search endpoint</a> and identify the values for `person_id`. <br><br>Example: `587cf802f65125cad923a266` */
936
+ id?: string;
937
+ /** @description The URL for the person's LinkedIn profile. <br><br>Example: `http://www.linkedin.com/in/jordan-blake-4c2b81de` */
938
+ linkedin_url?: string;
939
+ }[];
940
+ };
941
+ };
942
+ };
943
+ responses: {
944
+ /** @description 200 */
945
+ 200: {
946
+ headers: {
947
+ [name: string]: unknown;
948
+ };
949
+ content: {
950
+ "application/json": {
951
+ /**
952
+ * @description The signed 64-bit request ID for the enrichment request.
953
+ * @example 1039995589705121900
954
+ */
955
+ request_id?: number;
956
+ /**
957
+ * @description The exact string representation of the top-level request ID. When `phone_enrichment.status` is `pending`, pass this value unchanged to `GET /api/v1/webhook_result/{request_id}`. Do not pass `phone_enrichment.request_id`.
958
+ * @example -9045486258674686251
959
+ */
960
+ request_id_str?: string;
961
+ /**
962
+ * @description `success` for any `200` response. Error responses return `failed` instead. <br><br>This reflects the enrichment call itself, not whether any person was matched — a request that matches nobody still returns `success`.
963
+ * @example success
964
+ */
965
+ status?: string;
966
+ /**
967
+ * @description Always `null` on a `200` response. Populated only on error responses.
968
+ * @example null
969
+ */
970
+ error_code?: string | null;
971
+ /**
972
+ * @description Always `null` on a `200` response. Populated only on error responses.
973
+ * @example null
974
+ */
975
+ error_message?: string | null;
976
+ /**
977
+ * @description The number of objects you sent in the `details[]` array. Always returned.
978
+ * @default 0
979
+ * @example 3
980
+ */
981
+ total_requested_enrichments?: number;
982
+ /**
983
+ * @description The number of distinct people that consumed credits on this request. <br><br>This is a billing count, not a match count. A person who was matched but returned no credit-consuming data isn't included, so this can be lower than the number of entries in `matches` — or `0` while `matches` is non-empty. Duplicate entries in `details[]` that resolve to the same person are counted once. <br><br>**Not returned** when `run_waterfall_email` or `run_waterfall_phone` is `true`; those requests return the `waterfall` object instead.
984
+ * @default 0
985
+ * @example 3
986
+ */
987
+ unique_enriched_records?: number;
988
+ /**
989
+ * @description The number of entries in `details[]` that Apollo couldn't match to a person in its database. <br><br>**Not returned** when `run_waterfall_email` or `run_waterfall_phone` is `true`; those requests return the `waterfall` object instead.
990
+ * @default 0
991
+ * @example 0
992
+ */
993
+ missing_records?: number;
994
+ /**
995
+ * @description The total credits this request consumed. <br><br>This can be a fraction rather than a whole number, depending on your plan's credit pricing, so parse it as a decimal rather than an integer. <br><br>**Not returned** when `run_waterfall_email` or `run_waterfall_phone` is `true`; those requests return the `waterfall` object instead. Waterfall credit usage is reported separately, since enrichment completes asynchronously.
996
+ * @default 0
997
+ * @example 3
998
+ */
999
+ credits_consumed?: number;
1000
+ /** @description Returned **only** when you set `run_waterfall_email` or `run_waterfall_phone` to `true`. It reports whether Apollo accepted the waterfall request, whose results arrive asynchronously at your `webhook_url`. <br><br>When this object is present, `unique_enriched_records`, `missing_records`, and `credits_consumed` are omitted from the response. */
1001
+ waterfall?: {
1002
+ /**
1003
+ * @description Whether the waterfall enrichment request was accepted for asynchronous processing. A `200` response with a non-accepted status means no webhook will be delivered — read `message` for the reason.
1004
+ * @example accepted
1005
+ */
1006
+ status?: string;
1007
+ /**
1008
+ * @description A human-readable explanation of the waterfall status. When a request isn't accepted, this states why — for example, that no waterfall enrichment template is configured for your team.
1009
+ * @example Waterfall enrichment request accepted. Results will be sent to the provided webhook URL.
1010
+ */
1011
+ message?: string;
1012
+ /** @description Present only when some of the records you submitted couldn't be queued for waterfall enrichment. Each entry echoes the attributes Apollo was unable to process. */
1013
+ unprocessed_attributes?: Record<string, unknown>[];
1014
+ };
1015
+ /** @description Returned when you set `reveal_phone_number` to `true`, at least one person in `details[]` was matched, and you aren't using `run_waterfall_phone`. Phone numbers are enriched asynchronously and delivered to your `webhook_url` or made available to poll when `poll_only=true`.<br><br>If you requested `run_waterfall_phone` instead, phone status is reported through the `waterfall` object. */
1016
+ phone_enrichment?: {
1017
+ /**
1018
+ * @description Internal identifier for the phone enrichment job. Returned only when status is `pending`. Do not pass this value to `GET /api/v1/webhook_result/{request_id}`; use the top-level `request_id_str`.
1019
+ * @example 64a7ff0cc4dfae00013df1a5
1020
+ */
1021
+ request_id?: string;
1022
+ /**
1023
+ * @description `pending` means Apollo created a phone enrichment request and the result is delivered asynchronously. `skipped` means Apollo did not create a phone enrichment request, such as when direct-dial access is unavailable or phone enrichment is already in progress. No phone enrichment request or webhook is created. `not_attempted` means Apollo did not create a phone enrichment request because the returned person is not a saved Apollo person record. This can occur with `match_confidence: none` and with some provisional `low` matches. No phone credits are charged and no phone enrichment request or webhook is created.
1024
+ * @example pending
1025
+ * @enum {string}
1026
+ */
1027
+ status?: "pending" | "skipped" | "not_attempted";
1028
+ /**
1029
+ * @description A human-readable explanation of the phone enrichment status, including how to retrieve the result.
1030
+ * @example Phone enrichment is processing asynchronously. Retrieve the result by polling GET /api/v1/webhook_result/{request_id} with the top-level `request_id_str` field from this response. Retry after ~10 seconds.
1031
+ */
1032
+ message?: string;
1033
+ };
1034
+ matches?: {
1035
+ /** @example 64a7ff0cc4dfae00013df1a5 */
1036
+ id?: string;
1037
+ /** @example Marcus */
1038
+ first_name?: string;
1039
+ /** @example Ellery */
1040
+ last_name?: string;
1041
+ /** @example Marcus Ellery */
1042
+ name?: string;
1043
+ /** @example http://www.linkedin.com/in/marcus-ellery-4c2b81de */
1044
+ linkedin_url?: string;
1045
+ /** @example VP of Sales Operations */
1046
+ title?: string;
1047
+ /** @example verified */
1048
+ email_status?: string;
1049
+ /** @example https://media.example.com/photos/marcus-ellery.jpg */
1050
+ photo_url?: string;
1051
+ twitter_url?: unknown;
1052
+ github_url?: unknown;
1053
+ facebook_url?: unknown;
1054
+ extrapolated_email_confidence?: number | null;
1055
+ /** @example VP of Sales Operations at Apollo */
1056
+ headline?: string;
1057
+ /** @example marcus.ellery@apollo.io */
1058
+ email?: string;
1059
+ /** @example 5e66b6381e05b4008c8331b8 */
1060
+ organization_id?: string;
1061
+ /**
1062
+ * @example high
1063
+ * @enum {string}
1064
+ */
1065
+ match_confidence?: "high" | "medium" | "low" | "none";
1066
+ employment_history?: {
1067
+ /** @example 66d8c632580636000195735f */
1068
+ _id?: string;
1069
+ created_at?: unknown;
1070
+ /**
1071
+ * @default true
1072
+ * @example true
1073
+ */
1074
+ current?: boolean;
1075
+ degree?: unknown;
1076
+ description?: unknown;
1077
+ emails?: unknown;
1078
+ end_date?: unknown;
1079
+ grade_level?: unknown;
1080
+ kind?: unknown;
1081
+ major?: unknown;
1082
+ /** @example 5e66b6381e05b4008c8331b8 */
1083
+ organization_id?: string;
1084
+ /** @example Apollo */
1085
+ organization_name?: string;
1086
+ raw_address?: unknown;
1087
+ /** @example 2016-01-01 */
1088
+ start_date?: string;
1089
+ /** @example VP of Sales Operations */
1090
+ title?: string;
1091
+ updated_at?: unknown;
1092
+ /** @example 66d8c632580636000195735f */
1093
+ id?: string;
1094
+ /** @example 66d8c632580636000195735f */
1095
+ key?: string;
1096
+ }[];
1097
+ /** @example California */
1098
+ state?: string;
1099
+ /** @example San Francisco */
1100
+ city?: string;
1101
+ /** @example United States */
1102
+ country?: string;
1103
+ organization?: {
1104
+ /** @example 5e66b6381e05b4008c8331b8 */
1105
+ id?: string;
1106
+ /** @example Apollo.io */
1107
+ name?: string;
1108
+ /** @example http://www.apollo.io */
1109
+ website_url?: string;
1110
+ blog_url?: unknown;
1111
+ angellist_url?: unknown;
1112
+ /** @example https://www.linkedin.com/company/apolloio */
1113
+ linkedin_url?: string;
1114
+ /** @example https://x.com/useapolloio */
1115
+ twitter_url?: string;
1116
+ /** @example https://www.facebook.com/example-company */
1117
+ facebook_url?: string;
1118
+ primary_phone?: Record<string, unknown>;
1119
+ languages?: unknown[];
1120
+ /**
1121
+ * @default 0
1122
+ * @example 3514
1123
+ */
1124
+ alexa_ranking?: number;
1125
+ phone?: unknown;
1126
+ /** @example 18511550 */
1127
+ linkedin_uid?: string;
1128
+ /**
1129
+ * @default 0
1130
+ * @example 2015
1131
+ */
1132
+ founded_year?: number;
1133
+ publicly_traded_symbol?: unknown;
1134
+ publicly_traded_exchange?: unknown;
1135
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture */
1136
+ logo_url?: string;
1137
+ crunchbase_url?: unknown;
1138
+ /** @example apollo.io */
1139
+ primary_domain?: string;
1140
+ /** @example information technology & services */
1141
+ industry?: string;
1142
+ keywords?: string[];
1143
+ /**
1144
+ * @default 0
1145
+ * @example 1600
1146
+ */
1147
+ estimated_num_employees?: number;
1148
+ industries?: string[];
1149
+ secondary_industries?: unknown[];
1150
+ /**
1151
+ * @default true
1152
+ * @example true
1153
+ */
1154
+ snippets_loaded?: boolean;
1155
+ /** @example 5567cd4773696439b10b0000 */
1156
+ industry_tag_id?: string;
1157
+ industry_tag_hash?: {
1158
+ /** @example 5567cd4773696439b10b0000 */
1159
+ "information technology & services"?: string;
1160
+ };
1161
+ /** @description The North American Industry Classification System (NAICS) codes for the company. This field is only included when Apollo has NAICS codes for the company. */
1162
+ naics_codes?: string[];
1163
+ /** @description The Standard Industrial Classification (SIC) codes for the company. This field is only included when Apollo has SIC codes for the company. */
1164
+ sic_codes?: string[];
1165
+ /**
1166
+ * @default 0
1167
+ * @example 0
1168
+ */
1169
+ retail_location_count?: number;
1170
+ /** @example 415 Mission St, Floor 37, San Francisco, California 94105, US */
1171
+ raw_address?: string;
1172
+ /** @example 415 Mission St */
1173
+ street_address?: string;
1174
+ /** @example San Francisco */
1175
+ city?: string;
1176
+ /** @example California */
1177
+ state?: string;
1178
+ /** @example 94105-2301 */
1179
+ postal_code?: string;
1180
+ /** @example United States */
1181
+ country?: string;
1182
+ };
1183
+ /**
1184
+ * @default true
1185
+ * @example true
1186
+ */
1187
+ is_likely_to_engage?: boolean;
1188
+ /** @example 63f53afe4ceeca00016bdd2f */
1189
+ account_id?: string;
1190
+ account?: {
1191
+ /** @example 63f53afe4ceeca00016bdd2f */
1192
+ id?: string;
1193
+ /** @example Apollo.io */
1194
+ name?: string;
1195
+ /** @example http://www.apollo.io */
1196
+ website_url?: string;
1197
+ blog_url?: unknown;
1198
+ angellist_url?: unknown;
1199
+ /** @example https://www.linkedin.com/company/apolloio */
1200
+ linkedin_url?: string;
1201
+ /** @example https://x.com/useapolloio */
1202
+ twitter_url?: string;
1203
+ /** @example https://www.facebook.com/example-company */
1204
+ facebook_url?: string;
1205
+ primary_phone?: Record<string, unknown>;
1206
+ languages?: unknown[];
1207
+ /**
1208
+ * @default 0
1209
+ * @example 3514
1210
+ */
1211
+ alexa_ranking?: number;
1212
+ /** @example +1(202) 555-0114 */
1213
+ phone?: string;
1214
+ /** @example 18511550 */
1215
+ linkedin_uid?: string;
1216
+ /**
1217
+ * @default 0
1218
+ * @example 2015
1219
+ */
1220
+ founded_year?: number;
1221
+ publicly_traded_symbol?: unknown;
1222
+ publicly_traded_exchange?: unknown;
1223
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture */
1224
+ logo_url?: string;
1225
+ crunchbase_url?: unknown;
1226
+ /** @example apollo.io */
1227
+ primary_domain?: string;
1228
+ /** @example apollo.io */
1229
+ domain?: string;
1230
+ /** @example 6095a710bd01d100a506d4ac */
1231
+ team_id?: string;
1232
+ /** @example 5e66b6381e05b4008c8331b8 */
1233
+ organization_id?: string;
1234
+ account_stage_id?: unknown;
1235
+ /** @example csv_import */
1236
+ source?: string;
1237
+ /** @example salesforce */
1238
+ original_source?: string;
1239
+ creator_id?: unknown;
1240
+ /** @example 66aaac5a0e951f01b37012bd */
1241
+ owner_id?: string;
1242
+ /** @example 2023-02-21T21:43:26.351Z */
1243
+ created_at?: string;
1244
+ /** @example no_status */
1245
+ phone_status?: string;
1246
+ hubspot_id?: unknown;
1247
+ /** @example 001niCRAYZ4Ho6GTKv */
1248
+ salesforce_id?: string;
1249
+ /** @example 005Ux6UIthHN0CrhuW */
1250
+ crm_owner_id?: string;
1251
+ parent_account_id?: unknown;
1252
+ /** @example +12025550114 */
1253
+ sanitized_phone?: string;
1254
+ account_playbook_statuses?: unknown[];
1255
+ account_rule_config_statuses?: {
1256
+ /** @example 664f9eef1fded70001e4983e */
1257
+ _id?: string;
1258
+ created_at?: unknown;
1259
+ /** @example 65735e0ea63d2700faba5c6e */
1260
+ rule_action_config_id?: string;
1261
+ /** @example 65735e0ea63d2700faba5c6f */
1262
+ rule_config_id?: string;
1263
+ /** @example completed */
1264
+ status_cd?: string;
1265
+ updated_at?: unknown;
1266
+ /** @example 664f9eef1fded70001e4983e */
1267
+ id?: string;
1268
+ /** @example 664f9eef1fded70001e4983e */
1269
+ key?: string;
1270
+ }[];
1271
+ /** @example full */
1272
+ existence_level?: string;
1273
+ label_ids?: string[];
1274
+ typed_custom_fields?: Record<string, unknown>;
1275
+ custom_field_errors?: unknown;
1276
+ /** @example account */
1277
+ modality?: string;
1278
+ /** @example Uploaded from CSV */
1279
+ source_display_name?: string;
1280
+ /** @example https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv */
1281
+ salesforce_record_url?: string;
1282
+ /** @example https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv */
1283
+ crm_record_url?: string;
1284
+ };
1285
+ departments?: string[];
1286
+ subdepartments?: string[];
1287
+ /** @example founder */
1288
+ seniority?: string;
1289
+ functions?: string[];
1290
+ /**
1291
+ * @default true
1292
+ * @example false
1293
+ */
1294
+ show_intent?: boolean;
1295
+ /**
1296
+ * @default true
1297
+ * @example true
1298
+ */
1299
+ revealed_for_current_team?: boolean;
1300
+ }[];
1301
+ };
1302
+ };
1303
+ };
1304
+ /** @description 400 */
1305
+ 400: {
1306
+ headers: {
1307
+ [name: string]: unknown;
1308
+ };
1309
+ content: {
1310
+ "application/json": {
1311
+ /** @example failed */
1312
+ status?: string;
1313
+ /** @example INVALID_REQUEST */
1314
+ error_code?: string;
1315
+ /** @example invalid request, missing details */
1316
+ error_message?: string;
1317
+ } | {
1318
+ /** @example failed */
1319
+ status?: string;
1320
+ /** @example RECORD_LIMIT_EXCEEDED */
1321
+ error_code?: string;
1322
+ /** @example domain count cannot be more than 10 */
1323
+ error_message?: string;
1324
+ } | {
1325
+ /** @example Do not pass 'webhook_url' with poll_only=true. Either poll the result (poll_only=true, no webhook) or register a webhook (omit poll_only). */
1326
+ error?: string;
1327
+ };
1328
+ };
1329
+ };
1330
+ /** @description 401 */
1331
+ 401: {
1332
+ headers: {
1333
+ [name: string]: unknown;
1334
+ };
1335
+ content: {
1336
+ "text/plain": unknown;
1337
+ };
1338
+ };
1339
+ /** @description 422 */
1340
+ 422: {
1341
+ headers: {
1342
+ [name: string]: unknown;
1343
+ };
1344
+ content: {
1345
+ "application/json": {
1346
+ /** @example failed */
1347
+ status?: string;
1348
+ /** @example UNKNOWN_ERROR */
1349
+ error_code?: string;
1350
+ /** @example undefined method `length' for an instance of ActionController::Parameters */
1351
+ error_message?: string;
1352
+ } | {
1353
+ /** @example failed */
1354
+ status?: string;
1355
+ /** @example UNKNOWN_ERROR */
1356
+ error_code?: string;
1357
+ /** @example no implicit conversion of Symbol into Integer */
1358
+ error_message?: string;
1359
+ };
1360
+ };
1361
+ };
1362
+ /** @description 429 */
1363
+ 429: {
1364
+ headers: {
1365
+ [name: string]: unknown;
1366
+ };
1367
+ content: {
1368
+ "application/json": {
1369
+ error_details?: components["schemas"]["ErrorDetails"];
1370
+ /**
1371
+ * @deprecated
1372
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
1373
+ * @example The maximum number of api calls allowed for api/v1/people/bulk_match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
1374
+ */
1375
+ message?: string;
1376
+ };
1377
+ };
1378
+ };
1379
+ };
1380
+ };
1381
+ "organization-enrichment": {
1382
+ parameters: {
1383
+ query?: {
1384
+ /** @description The domain of the company that you want to enrich. Do not include `www.`, the `@` symbol, or similar. Use `domain`, `linkedin_url`, or `website` to identify the company. You can also provide `name` to improve match accuracy. <br><br>Example: `apollo.io` or `microsoft.com` */
1385
+ domain?: string;
1386
+ /** @description The URL for the company's LinkedIn profile. Use `domain`, `linkedin_url`, or `website` to identify the company. You can also provide `name` to improve match accuracy. <br><br>Example: `https://www.linkedin.com/company/apolloio` */
1387
+ linkedin_url?: string;
1388
+ /** @description The name of the company that you want to enrich. Provide this with `domain`, `linkedin_url`, or `website` to improve match accuracy. <br><br>Example: `apollo` */
1389
+ name?: string;
1390
+ /** @description The full website URL of the company that you want to enrich. Use `domain`, `linkedin_url`, or `website` to identify the company. You can also provide `name` to improve match accuracy. <br><br>Example: `http://www.apollo.io` */
1391
+ website?: string;
1392
+ };
1393
+ header?: never;
1394
+ path?: never;
1395
+ cookie?: never;
1396
+ };
1397
+ requestBody?: never;
1398
+ responses: {
1399
+ /** @description 200 */
1400
+ 200: {
1401
+ headers: {
1402
+ [name: string]: unknown;
1403
+ };
1404
+ content: {
1405
+ "application/json": {
1406
+ organization?: {
1407
+ /** @example 5e66b6381e05b4008c8331b8 */
1408
+ id?: string;
1409
+ /** @example Apollo.io */
1410
+ name?: string;
1411
+ /** @example http://www.apollo.io */
1412
+ website_url?: string;
1413
+ blog_url?: unknown;
1414
+ angellist_url?: unknown;
1415
+ /** @example https://www.linkedin.com/company/apolloio */
1416
+ linkedin_url?: string;
1417
+ /** @example https://x.com/useapolloio */
1418
+ twitter_url?: string;
1419
+ /** @example https://www.facebook.com/example-company */
1420
+ facebook_url?: string;
1421
+ primary_phone?: Record<string, unknown>;
1422
+ /** @description The distinct languages associated with the organization. */
1423
+ languages?: string[];
1424
+ /**
1425
+ * @description The number of distinct values in `languages`.
1426
+ * @default 0
1427
+ * @example 0
1428
+ */
1429
+ num_languages?: number;
1430
+ /**
1431
+ * @default 0
1432
+ * @example 3514
1433
+ */
1434
+ alexa_ranking?: number;
1435
+ phone?: unknown;
1436
+ /** @example 18511550 */
1437
+ linkedin_uid?: string;
1438
+ /**
1439
+ * @default 0
1440
+ * @example 2015
1441
+ */
1442
+ founded_year?: number;
1443
+ publicly_traded_symbol?: unknown;
1444
+ publicly_traded_exchange?: unknown;
1445
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture */
1446
+ logo_url?: string;
1447
+ crunchbase_url?: unknown;
1448
+ /** @example apollo.io */
1449
+ primary_domain?: string;
1450
+ /** @example information technology & services */
1451
+ industry?: string;
1452
+ keywords?: string[];
1453
+ /**
1454
+ * @default 0
1455
+ * @example 1600
1456
+ */
1457
+ estimated_num_employees?: number;
1458
+ industries?: string[];
1459
+ secondary_industries?: unknown[];
1460
+ /**
1461
+ * @default true
1462
+ * @example true
1463
+ */
1464
+ snippets_loaded?: boolean;
1465
+ /** @example 5567cd4773696439b10b0000 */
1466
+ industry_tag_id?: string;
1467
+ industry_tag_hash?: {
1468
+ /** @example 5567cd4773696439b10b0000 */
1469
+ "information technology & services"?: string;
1470
+ };
1471
+ /** @description The North American Industry Classification System (NAICS) codes for the company. This field is only included when Apollo has NAICS codes for the company. */
1472
+ naics_codes?: string[];
1473
+ /** @description The Standard Industrial Classification (SIC) codes for the company. This field is only included when Apollo has SIC codes for the company. */
1474
+ sic_codes?: string[];
1475
+ /**
1476
+ * @default 0
1477
+ * @example 0
1478
+ */
1479
+ retail_location_count?: number;
1480
+ /**
1481
+ * @description The number of retail company locations that aren't marked as closed.
1482
+ * @default 0
1483
+ * @example 0
1484
+ */
1485
+ num_retail_locations?: number;
1486
+ /** @example 415 Mission St, Floor 37, San Francisco, California 94105, US */
1487
+ raw_address?: string;
1488
+ /** @example 415 Mission St */
1489
+ street_address?: string;
1490
+ /** @example San Francisco */
1491
+ city?: string;
1492
+ /** @example California */
1493
+ state?: string;
1494
+ /** @example 94105-2301 */
1495
+ postal_code?: string;
1496
+ /** @example United States */
1497
+ country?: string;
1498
+ /** @description The Apollo organization ID of the immediate parent organization. Returns `null` when the organization has no parent. */
1499
+ owned_by_organization_id?: unknown;
1500
+ /** @description The immediate parent organization. Omitted when the organization has no parent. */
1501
+ owned_by_organization?: {
1502
+ /** @example parent_org_1234567890abcdef */
1503
+ id?: string;
1504
+ /** @example Example Parent Company */
1505
+ name?: string;
1506
+ /** @example https://www.example-parent.com */
1507
+ website_url?: string;
1508
+ };
1509
+ /** @description Apollo organization IDs in the ownership chain, ordered from the immediate parent to the ultimate parent. Omitted when the organization has no ownership chain. */
1510
+ owned_by_chain?: string[];
1511
+ /** @description The topmost parent in the ownership chain. Omitted when the organization has no ultimate parent. */
1512
+ ultimate_parent_organization?: {
1513
+ /** @example ultimate_parent_abcdef123456 */
1514
+ id?: string;
1515
+ /** @example Example Holdings */
1516
+ name?: string;
1517
+ /** @example https://www.example-holdings.com */
1518
+ website_url?: string;
1519
+ };
1520
+ /** @example Search, engage, and convert over 240 million contacts at over 30 million companies with Apollo's sales intelligence and engagement platform. */
1521
+ seo_description?: string;
1522
+ /**
1523
+ * @example Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.
1524
+ *
1525
+ * Celebrating a $100M Series D Funding Round 🦄
1526
+ */
1527
+ short_description?: string;
1528
+ /** @description Subsidiaries directly owned by the organization. */
1529
+ suborganizations?: {
1530
+ /** @example subsidiary_org_1234567890ab */
1531
+ id?: string;
1532
+ /** @example Example Subsidiary */
1533
+ name?: string;
1534
+ /** @example https://www.example-subsidiary.com */
1535
+ website_url?: string;
1536
+ industries?: string[];
1537
+ /**
1538
+ * @default 0
1539
+ * @example 250
1540
+ */
1541
+ estimated_num_employees?: number;
1542
+ /** @example United States */
1543
+ country?: string;
1544
+ }[];
1545
+ /**
1546
+ * @description The number of subsidiaries directly owned by the organization.
1547
+ * @default 0
1548
+ * @example 0
1549
+ */
1550
+ num_suborganizations?: number;
1551
+ /** @example 100M */
1552
+ annual_revenue_printed?: string;
1553
+ /**
1554
+ * @default 0
1555
+ * @example 100000000
1556
+ */
1557
+ annual_revenue?: number;
1558
+ /**
1559
+ * @default 0
1560
+ * @example 251200000
1561
+ */
1562
+ total_funding?: number;
1563
+ /** @example 251.2M */
1564
+ total_funding_printed?: string;
1565
+ /** @example 2023-08-01T00:00:00.000+00:00 */
1566
+ latest_funding_round_date?: string;
1567
+ /** @example Series D */
1568
+ latest_funding_stage?: string;
1569
+ funding_events?: {
1570
+ /** @example 6574c1ff9b797d0001fdab1b */
1571
+ id?: string;
1572
+ /** @example 2023-08-01T00:00:00.000+00:00 */
1573
+ date?: string;
1574
+ news_url?: unknown;
1575
+ /** @example Series D */
1576
+ type?: string;
1577
+ /** @example Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners */
1578
+ investors?: string;
1579
+ /** @example 100M */
1580
+ amount?: string;
1581
+ /** @example $ */
1582
+ currency?: string;
1583
+ }[];
1584
+ technology_names?: string[];
1585
+ current_technologies?: {
1586
+ /** @example ai */
1587
+ uid?: string;
1588
+ /** @example AI */
1589
+ name?: string;
1590
+ /** @example Other */
1591
+ category?: string;
1592
+ }[];
1593
+ org_chart_root_people_ids?: string[];
1594
+ /** @example OrgChart::SectorHierarchy::Rules::IT */
1595
+ org_chart_sector?: string;
1596
+ /**
1597
+ * @default true
1598
+ * @example false
1599
+ */
1600
+ org_chart_removed?: boolean;
1601
+ /**
1602
+ * @default true
1603
+ * @example true
1604
+ */
1605
+ org_chart_show_department_filter?: boolean;
1606
+ /** @example 63f53afe4ceeca00016bdd37 */
1607
+ account_id?: string;
1608
+ account?: {
1609
+ /** @example 63f53afe4ceeca00016bdd37 */
1610
+ id?: string;
1611
+ /** @example apollo.io */
1612
+ domain?: string;
1613
+ /** @example Apollo */
1614
+ name?: string;
1615
+ /** @example 6095a710bd01d100a506d4ac */
1616
+ team_id?: string;
1617
+ /** @example 5e66b6381e05b4008c8331b8 */
1618
+ organization_id?: string;
1619
+ account_stage_id?: unknown;
1620
+ /** @example salesforce */
1621
+ source?: string;
1622
+ /** @example salesforce */
1623
+ original_source?: string;
1624
+ creator_id?: unknown;
1625
+ /** @example 60affe7d6e270a00f5db6fe4 */
1626
+ owner_id?: string;
1627
+ /** @example 2023-02-21T21:43:26.351Z */
1628
+ created_at?: string;
1629
+ /** @example +1(202) 555-0114 */
1630
+ phone?: string;
1631
+ /** @example no_status */
1632
+ phone_status?: string;
1633
+ hubspot_id?: unknown;
1634
+ salesforce_id?: unknown;
1635
+ crm_owner_id?: unknown;
1636
+ parent_account_id?: unknown;
1637
+ linkedin_url?: unknown;
1638
+ /** @example +12025550114 */
1639
+ sanitized_phone?: string;
1640
+ account_playbook_statuses?: unknown[];
1641
+ account_rule_config_statuses?: unknown[];
1642
+ /** @example full */
1643
+ existence_level?: string;
1644
+ label_ids?: string[];
1645
+ typed_custom_fields?: Record<string, unknown>;
1646
+ custom_field_errors?: Record<string, unknown>;
1647
+ /** @example account */
1648
+ modality?: string;
1649
+ /** @example Imported from Salesforce */
1650
+ source_display_name?: string;
1651
+ crm_record_url?: unknown;
1652
+ /**
1653
+ * @default true
1654
+ * @example false
1655
+ */
1656
+ show_intent?: boolean;
1657
+ /**
1658
+ * @default true
1659
+ * @example false
1660
+ */
1661
+ has_intent_signal_account?: boolean;
1662
+ intent_signal_account?: unknown;
1663
+ };
1664
+ departmental_head_count?: {
1665
+ /**
1666
+ * @default 0
1667
+ * @example 228
1668
+ */
1669
+ engineering?: number;
1670
+ /**
1671
+ * @default 0
1672
+ * @example 28
1673
+ */
1674
+ operations?: number;
1675
+ /**
1676
+ * @default 0
1677
+ * @example 30
1678
+ */
1679
+ support?: number;
1680
+ /**
1681
+ * @default 0
1682
+ * @example 36
1683
+ */
1684
+ marketing?: number;
1685
+ /**
1686
+ * @default 0
1687
+ * @example 29
1688
+ */
1689
+ human_resources?: number;
1690
+ /**
1691
+ * @default 0
1692
+ * @example 177
1693
+ */
1694
+ sales?: number;
1695
+ /**
1696
+ * @default 0
1697
+ * @example 8
1698
+ */
1699
+ finance?: number;
1700
+ /**
1701
+ * @default 0
1702
+ * @example 8
1703
+ */
1704
+ consulting?: number;
1705
+ /**
1706
+ * @default 0
1707
+ * @example 5
1708
+ */
1709
+ legal?: number;
1710
+ /**
1711
+ * @default 0
1712
+ * @example 27
1713
+ */
1714
+ arts_and_design?: number;
1715
+ /**
1716
+ * @default 0
1717
+ * @example 3
1718
+ */
1719
+ accounting?: number;
1720
+ /**
1721
+ * @default 0
1722
+ * @example 14
1723
+ */
1724
+ business_development?: number;
1725
+ /**
1726
+ * @default 0
1727
+ * @example 8
1728
+ */
1729
+ information_technology?: number;
1730
+ /**
1731
+ * @default 0
1732
+ * @example 6
1733
+ */
1734
+ education?: number;
1735
+ /**
1736
+ * @default 0
1737
+ * @example 3
1738
+ */
1739
+ media_and_commmunication?: number;
1740
+ /**
1741
+ * @default 0
1742
+ * @example 16
1743
+ */
1744
+ product_management?: number;
1745
+ /**
1746
+ * @default 0
1747
+ * @example 3
1748
+ */
1749
+ entrepreneurship?: number;
1750
+ /**
1751
+ * @default 0
1752
+ * @example 6
1753
+ */
1754
+ data_science?: number;
1755
+ /**
1756
+ * @default 0
1757
+ * @example 3
1758
+ */
1759
+ administrative?: number;
1760
+ };
1761
+ /**
1762
+ * @description The percentage change in the company's total headcount over the previous 6 months. Returns `null` when growth data is not available for the company.
1763
+ * @example 12.3
1764
+ */
1765
+ organization_headcount_six_month_growth?: number;
1766
+ /**
1767
+ * @description The percentage change in the company's total headcount over the previous 12 months. Returns `null` when growth data is not available for the company.
1768
+ * @example 24.6
1769
+ */
1770
+ organization_headcount_twelve_month_growth?: number;
1771
+ /**
1772
+ * @description The percentage change in the company's total headcount over the previous 24 months. Returns `null` when growth data is not available for the company.
1773
+ * @example 48.9
1774
+ */
1775
+ organization_headcount_twenty_four_month_growth?: number;
1776
+ };
1777
+ };
1778
+ };
1779
+ };
1780
+ /** @description 401 */
1781
+ 401: {
1782
+ headers: {
1783
+ [name: string]: unknown;
1784
+ };
1785
+ content: {
1786
+ "text/plain": unknown;
1787
+ };
1788
+ };
1789
+ /** @description 403 */
1790
+ 403: {
1791
+ headers: {
1792
+ [name: string]: unknown;
1793
+ };
1794
+ content: {
1795
+ "application/json": {
1796
+ error_details?: components["schemas"]["ErrorDetails"];
1797
+ /**
1798
+ * @deprecated
1799
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
1800
+ * @example This API key is not authorized to access api/v1/organizations/enrich. Request an API key from your administrator that includes this endpoint in its configured scope.
1801
+ */
1802
+ error?: string;
1803
+ /**
1804
+ * @deprecated
1805
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
1806
+ * @example API_INACCESSIBLE
1807
+ */
1808
+ error_code?: string;
1809
+ };
1810
+ };
1811
+ };
1812
+ /** @description 422 */
1813
+ 422: {
1814
+ headers: {
1815
+ [name: string]: unknown;
1816
+ };
1817
+ content: {
1818
+ "application/json": {
1819
+ error_details?: components["schemas"]["ErrorDetails"];
1820
+ };
1821
+ };
1822
+ };
1823
+ /** @description 429 */
1824
+ 429: {
1825
+ headers: {
1826
+ [name: string]: unknown;
1827
+ };
1828
+ content: {
1829
+ "application/json": {
1830
+ error_details?: components["schemas"]["ErrorDetails"];
1831
+ /**
1832
+ * @deprecated
1833
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
1834
+ * @example The maximum number of api calls allowed for api/v1/organizations/enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
1835
+ */
1836
+ message?: string;
1837
+ };
1838
+ };
1839
+ };
1840
+ };
1841
+ };
1842
+ "bulk-organization-enrichment": {
1843
+ parameters: {
1844
+ query?: {
1845
+ /** @description The domain of each company that you want to enrich. Do not include `www.`, the `@` symbol, or similar. <br><br>Use this parameter to match companies by domain only. To match by LinkedIn URL, name, or website in addition to domain, use the `details` array in the request body instead. <br><br>This parameter is required unless you provide a `details` payload in the request body. <br><br>Example: `apollo.io` and `microsoft.com` */
1846
+ "domains[]"?: string[];
1847
+ };
1848
+ header?: never;
1849
+ path?: never;
1850
+ cookie?: never;
1851
+ };
1852
+ requestBody?: {
1853
+ content: {
1854
+ "application/json": {
1855
+ /** @description Provide info for each company you want to enrich as an object within this array. Add up to 10 companies. Each object can include any combination of `domain`, `linkedin_url`, `name`, and `website`. Providing more than one value for a company improves match accuracy. <br><br>If you provide a `details` payload, it takes precedence over the `domains[]` query parameter. */
1856
+ details?: {
1857
+ /** @description The domain of the company that you want to enrich. Do not include `www.`, the `@` symbol, or similar. <br><br>Example: `apollo.io` or `microsoft.com` */
1858
+ domain?: string;
1859
+ /** @description The URL for the company's LinkedIn profile. <br><br>Example: `https://www.linkedin.com/company/apolloio` */
1860
+ linkedin_url?: string;
1861
+ /** @description The name of the company that you want to enrich. <br><br>Example: `apollo` */
1862
+ name?: string;
1863
+ /** @description The full website URL of the company that you want to enrich. <br><br>Example: `http://www.apollo.io` */
1864
+ website?: string;
1865
+ }[];
1866
+ };
1867
+ };
1868
+ };
1869
+ responses: {
1870
+ /** @description 200 */
1871
+ 200: {
1872
+ headers: {
1873
+ [name: string]: unknown;
1874
+ };
1875
+ content: {
1876
+ "application/json": {
1877
+ /** @example success */
1878
+ status?: string;
1879
+ error_code?: unknown;
1880
+ error_message?: unknown;
1881
+ /**
1882
+ * @description The total number of companies submitted in the `details` payload, including duplicates. Returned only when you enrich using the `details` request body; `null` for `domains[]` requests.
1883
+ * @default 0
1884
+ * @example 4
1885
+ */
1886
+ total_requested_records?: number;
1887
+ /**
1888
+ * @description The total number of domains submitted via the `domains[]` query parameter, including duplicates. Returned only for `domains[]` requests; `null` when you enrich using the `details` payload.
1889
+ * @default 0
1890
+ * @example 4
1891
+ */
1892
+ total_requested_domains?: number;
1893
+ /**
1894
+ * @description The number of unique domains submitted via the `domains[]` query parameter. Returned only for `domains[]` requests; `null` when you enrich using the `details` payload.
1895
+ * @default 0
1896
+ * @example 4
1897
+ */
1898
+ unique_domains?: number;
1899
+ /**
1900
+ * @description The number of unique companies submitted in the `details` payload after de-duplication. Returned only when you enrich using the `details` request body; `null` for `domains[]` requests.
1901
+ * @default 0
1902
+ * @example 4
1903
+ */
1904
+ unique_records?: number;
1905
+ /**
1906
+ * @default 0
1907
+ * @example 4
1908
+ */
1909
+ unique_enriched_records?: number;
1910
+ /**
1911
+ * @default 0
1912
+ * @example 0
1913
+ */
1914
+ missing_records?: number;
1915
+ organizations?: {
1916
+ /** @example 5e66b6381e05b4008c8331b8 */
1917
+ id?: string;
1918
+ /** @example Apollo.io */
1919
+ name?: string;
1920
+ /** @example http://www.apollo.io */
1921
+ website_url?: string;
1922
+ blog_url?: unknown;
1923
+ angellist_url?: unknown;
1924
+ /** @example https://www.linkedin.com/company/apolloio */
1925
+ linkedin_url?: string;
1926
+ /** @example https://x.com/useapolloio */
1927
+ twitter_url?: string;
1928
+ /** @example https://www.facebook.com/example-company */
1929
+ facebook_url?: string;
1930
+ primary_phone?: Record<string, unknown>;
1931
+ /** @description The distinct languages associated with the organization. */
1932
+ languages?: string[];
1933
+ /**
1934
+ * @description The number of distinct values in `languages`.
1935
+ * @default 0
1936
+ * @example 0
1937
+ */
1938
+ num_languages?: number;
1939
+ /**
1940
+ * @default 0
1941
+ * @example 3514
1942
+ */
1943
+ alexa_ranking?: number;
1944
+ phone?: unknown;
1945
+ /** @example 18511550 */
1946
+ linkedin_uid?: string;
1947
+ /**
1948
+ * @default 0
1949
+ * @example 2015
1950
+ */
1951
+ founded_year?: number;
1952
+ publicly_traded_symbol?: unknown;
1953
+ publicly_traded_exchange?: unknown;
1954
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture */
1955
+ logo_url?: string;
1956
+ crunchbase_url?: unknown;
1957
+ /** @example apollo.io */
1958
+ primary_domain?: string;
1959
+ /** @example information technology & services */
1960
+ industry?: string;
1961
+ keywords?: string[];
1962
+ /**
1963
+ * @default 0
1964
+ * @example 1600
1965
+ */
1966
+ estimated_num_employees?: number;
1967
+ industries?: string[];
1968
+ secondary_industries?: unknown[];
1969
+ /**
1970
+ * @default true
1971
+ * @example true
1972
+ */
1973
+ snippets_loaded?: boolean;
1974
+ /** @example 5567cd4773696439b10b0000 */
1975
+ industry_tag_id?: string;
1976
+ industry_tag_hash?: {
1977
+ /** @example 5567cd4773696439b10b0000 */
1978
+ "information technology & services"?: string;
1979
+ };
1980
+ /** @description The North American Industry Classification System (NAICS) codes for the company. This field is only included when Apollo has NAICS codes for the company. */
1981
+ naics_codes?: string[];
1982
+ /** @description The Standard Industrial Classification (SIC) codes for the company. This field is only included when Apollo has SIC codes for the company. */
1983
+ sic_codes?: string[];
1984
+ /**
1985
+ * @default 0
1986
+ * @example 0
1987
+ */
1988
+ retail_location_count?: number;
1989
+ /**
1990
+ * @description The number of retail company locations that aren't marked as closed.
1991
+ * @default 0
1992
+ * @example 0
1993
+ */
1994
+ num_retail_locations?: number;
1995
+ /** @example 415 mission st, floor 37, san francisco, california 94105, us */
1996
+ raw_address?: string;
1997
+ /** @example 415 Mission St */
1998
+ street_address?: string;
1999
+ /** @example San Francisco */
2000
+ city?: string;
2001
+ /** @example California */
2002
+ state?: string;
2003
+ /** @example United States */
2004
+ country?: string;
2005
+ /** @example 94105-2301 */
2006
+ postal_code?: string;
2007
+ /** @description The Apollo organization ID of the immediate parent organization. Returns `null` when the organization has no parent. */
2008
+ owned_by_organization_id?: unknown;
2009
+ /** @description The immediate parent organization. Omitted when the organization has no parent. */
2010
+ owned_by_organization?: {
2011
+ /** @example parent_org_1234567890abcdef */
2012
+ id?: string;
2013
+ /** @example Example Parent Company */
2014
+ name?: string;
2015
+ /** @example https://www.example-parent.com */
2016
+ website_url?: string;
2017
+ };
2018
+ /** @description Apollo organization IDs in the ownership chain, ordered from the immediate parent to the ultimate parent. Omitted when the organization has no ownership chain. */
2019
+ owned_by_chain?: string[];
2020
+ /** @description The topmost parent in the ownership chain. Omitted when the organization has no ultimate parent. */
2021
+ ultimate_parent_organization?: {
2022
+ /** @example ultimate_parent_abcdef123456 */
2023
+ id?: string;
2024
+ /** @example Example Holdings */
2025
+ name?: string;
2026
+ /** @example https://www.example-holdings.com */
2027
+ website_url?: string;
2028
+ };
2029
+ /**
2030
+ * @description The number of subsidiaries directly owned by the organization.
2031
+ * @default 0
2032
+ * @example 0
2033
+ */
2034
+ num_suborganizations?: number;
2035
+ /** @description Aggregated firmographic data for subsidiaries directly owned by the organization. Returns zero and empty arrays when no subsidiary data is available. */
2036
+ subsidiary_rollups?: {
2037
+ /**
2038
+ * @description The sum of estimated employee counts across the organization's subsidiaries.
2039
+ * @default 0
2040
+ * @example 0
2041
+ */
2042
+ total_estimated_employee_count?: number;
2043
+ /** @description Distinct countries represented by the organization's subsidiaries. */
2044
+ countries?: string[];
2045
+ /** @description Distinct industries represented by the organization's subsidiaries. */
2046
+ industries?: string[];
2047
+ };
2048
+ /** @example Search, engage, and convert over 240 million contacts at over 30 million companies with Apollo's sales intelligence and engagement platform. */
2049
+ seo_description?: string;
2050
+ /**
2051
+ * @example Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.
2052
+ *
2053
+ * Celebrating a $100M Series D Funding Round 🦄
2054
+ */
2055
+ short_description?: string;
2056
+ /** @example 63f53afe4ceeca00016bdd37 */
2057
+ account_id?: string;
2058
+ account?: {
2059
+ /** @example 63f53afe4ceeca00016bdd37 */
2060
+ id?: string;
2061
+ /** @example apollo.io */
2062
+ domain?: string;
2063
+ /** @example Apollo */
2064
+ name?: string;
2065
+ /** @example 6095a710bd01d100a506d4ac */
2066
+ team_id?: string;
2067
+ /** @example 5e66b6381e05b4008c8331b8 */
2068
+ organization_id?: string;
2069
+ account_stage_id?: unknown;
2070
+ /** @example salesforce */
2071
+ source?: string;
2072
+ /** @example salesforce */
2073
+ original_source?: string;
2074
+ creator_id?: unknown;
2075
+ /** @example 60affe7d6e270a00f5db6fe4 */
2076
+ owner_id?: string;
2077
+ /** @example 2023-02-21T21:43:26.351Z */
2078
+ created_at?: string;
2079
+ /** @example +1(202) 555-0114 */
2080
+ phone?: string;
2081
+ /** @example no_status */
2082
+ phone_status?: string;
2083
+ hubspot_id?: unknown;
2084
+ salesforce_id?: unknown;
2085
+ crm_owner_id?: unknown;
2086
+ parent_account_id?: unknown;
2087
+ linkedin_url?: unknown;
2088
+ /** @example +12025550114 */
2089
+ sanitized_phone?: string;
2090
+ account_playbook_statuses?: unknown[];
2091
+ account_rule_config_statuses?: unknown[];
2092
+ /** @example full */
2093
+ existence_level?: string;
2094
+ label_ids?: string[];
2095
+ typed_custom_fields?: Record<string, unknown>;
2096
+ custom_field_errors?: unknown;
2097
+ /** @example account */
2098
+ modality?: string;
2099
+ /** @example Imported from Salesforce */
2100
+ source_display_name?: string;
2101
+ crm_record_url?: unknown;
2102
+ /**
2103
+ * @default true
2104
+ * @example false
2105
+ */
2106
+ show_intent?: boolean;
2107
+ /**
2108
+ * @default true
2109
+ * @example false
2110
+ */
2111
+ has_intent_signal_account?: boolean;
2112
+ intent_signal_account?: unknown;
2113
+ };
2114
+ departmental_head_count?: {
2115
+ /**
2116
+ * @default 0
2117
+ * @example 228
2118
+ */
2119
+ engineering?: number;
2120
+ /**
2121
+ * @default 0
2122
+ * @example 28
2123
+ */
2124
+ operations?: number;
2125
+ /**
2126
+ * @default 0
2127
+ * @example 30
2128
+ */
2129
+ support?: number;
2130
+ /**
2131
+ * @default 0
2132
+ * @example 36
2133
+ */
2134
+ marketing?: number;
2135
+ /**
2136
+ * @default 0
2137
+ * @example 29
2138
+ */
2139
+ human_resources?: number;
2140
+ /**
2141
+ * @default 0
2142
+ * @example 177
2143
+ */
2144
+ sales?: number;
2145
+ /**
2146
+ * @default 0
2147
+ * @example 8
2148
+ */
2149
+ finance?: number;
2150
+ /**
2151
+ * @default 0
2152
+ * @example 8
2153
+ */
2154
+ consulting?: number;
2155
+ /**
2156
+ * @default 0
2157
+ * @example 5
2158
+ */
2159
+ legal?: number;
2160
+ /**
2161
+ * @default 0
2162
+ * @example 27
2163
+ */
2164
+ arts_and_design?: number;
2165
+ /**
2166
+ * @default 0
2167
+ * @example 3
2168
+ */
2169
+ accounting?: number;
2170
+ /**
2171
+ * @default 0
2172
+ * @example 14
2173
+ */
2174
+ business_development?: number;
2175
+ /**
2176
+ * @default 0
2177
+ * @example 8
2178
+ */
2179
+ information_technology?: number;
2180
+ /**
2181
+ * @default 0
2182
+ * @example 6
2183
+ */
2184
+ education?: number;
2185
+ /**
2186
+ * @default 0
2187
+ * @example 3
2188
+ */
2189
+ media_and_commmunication?: number;
2190
+ /**
2191
+ * @default 0
2192
+ * @example 16
2193
+ */
2194
+ product_management?: number;
2195
+ /**
2196
+ * @default 0
2197
+ * @example 3
2198
+ */
2199
+ entrepreneurship?: number;
2200
+ /**
2201
+ * @default 0
2202
+ * @example 6
2203
+ */
2204
+ data_science?: number;
2205
+ /**
2206
+ * @default 0
2207
+ * @example 3
2208
+ */
2209
+ administrative?: number;
2210
+ };
2211
+ /**
2212
+ * @default true
2213
+ * @example false
2214
+ */
2215
+ show_intent?: boolean;
2216
+ /**
2217
+ * @default true
2218
+ * @example false
2219
+ */
2220
+ has_intent_signal_account?: boolean;
2221
+ intent_signal_account?: unknown;
2222
+ /**
2223
+ * @description The percentage change in the company's total headcount over the previous 6 months. Returns `null` when growth data is not available for the company.
2224
+ * @example 12.3
2225
+ */
2226
+ organization_headcount_six_month_growth?: number;
2227
+ /**
2228
+ * @description The percentage change in the company's total headcount over the previous 12 months. Returns `null` when growth data is not available for the company.
2229
+ * @example 24.6
2230
+ */
2231
+ organization_headcount_twelve_month_growth?: number;
2232
+ /**
2233
+ * @description The percentage change in the company's total headcount over the previous 24 months. Returns `null` when growth data is not available for the company.
2234
+ * @example 48.9
2235
+ */
2236
+ organization_headcount_twenty_four_month_growth?: number;
2237
+ }[];
2238
+ };
2239
+ };
2240
+ };
2241
+ /** @description 400 */
2242
+ 400: {
2243
+ headers: {
2244
+ [name: string]: unknown;
2245
+ };
2246
+ content: {
2247
+ "text/plain": {
2248
+ /** @example failed */
2249
+ status?: string;
2250
+ /** @example INVALID_REQUEST */
2251
+ error_code?: string;
2252
+ /** @example invalid request, missing domains */
2253
+ error_message?: string;
2254
+ };
2255
+ "application/json": {
2256
+ /** @example failed */
2257
+ status?: string;
2258
+ /** @example RECORD_LIMIT_EXCEEDED */
2259
+ error_code?: string;
2260
+ /** @example domain count cannot be more than 10 */
2261
+ error_message?: string;
2262
+ };
2263
+ };
2264
+ };
2265
+ /** @description 401 */
2266
+ 401: {
2267
+ headers: {
2268
+ [name: string]: unknown;
2269
+ };
2270
+ content: {
2271
+ "text/plain": unknown;
2272
+ };
2273
+ };
2274
+ /** @description 403 */
2275
+ 403: {
2276
+ headers: {
2277
+ [name: string]: unknown;
2278
+ };
2279
+ content: {
2280
+ "application/json": {
2281
+ error_details?: components["schemas"]["ErrorDetails"];
2282
+ /**
2283
+ * @deprecated
2284
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2285
+ * @example This API key is not authorized to access api/v1/organizations/bulk_enrich. Request an API key from your administrator that includes this endpoint in its configured scope.
2286
+ */
2287
+ error?: string;
2288
+ /**
2289
+ * @deprecated
2290
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2291
+ * @example API_INACCESSIBLE
2292
+ */
2293
+ error_code?: string;
2294
+ };
2295
+ };
2296
+ };
2297
+ /** @description 422 */
2298
+ 422: {
2299
+ headers: {
2300
+ [name: string]: unknown;
2301
+ };
2302
+ content: {
2303
+ "application/json": {
2304
+ error_details?: components["schemas"]["ErrorDetails"];
2305
+ /** @example failed */
2306
+ status?: string;
2307
+ /**
2308
+ * @deprecated
2309
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2310
+ * @example UNKNOWN_ERROR
2311
+ */
2312
+ error_code?: string;
2313
+ /** @description The error message returned by the failed enrichment operation. */
2314
+ error_message?: string;
2315
+ };
2316
+ };
2317
+ };
2318
+ /** @description 429 */
2319
+ 429: {
2320
+ headers: {
2321
+ [name: string]: unknown;
2322
+ };
2323
+ content: {
2324
+ "application/json": {
2325
+ error_details?: components["schemas"]["ErrorDetails"];
2326
+ /**
2327
+ * @deprecated
2328
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2329
+ * @example The maximum number of api calls allowed for api/v1/organizations/bulk_enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
2330
+ */
2331
+ message?: string;
2332
+ };
2333
+ };
2334
+ };
2335
+ };
2336
+ };
2337
+ "people-api-search": {
2338
+ parameters: {
2339
+ query?: {
2340
+ /** @description Job titles held by the people you want to find. For a person to be included in search results, they only need to match 1 of the job titles you add. Adding more job titles expands your search results. <br><br>Results also include job titles with the same terms, even if they are not exact matches. For example, searching for `marketing manager` might return people with the job title `content marketing manager`. <br><br>Use this parameter in combination with the `person_seniorities[]` parameter to find people based on specific job functions and seniority levels. <br><br>Examples: `sales development representative`; `marketing manager`; `research analyst` */
2341
+ "person_titles[]"?: string[];
2342
+ /** @description This parameter determines whether people with job titles similar to the titles you define in the `person_titles[]` parameter are returned in the response. <br><br>Set this parameter to `false` when using `person_titles[]` to return only strict matches for job titles. */
2343
+ include_similar_titles?: boolean;
2344
+ /** @description Exclude people whose current job title matches any of these job titles. This is the counterpart to `person_titles[]`. <br><br>Like `person_titles[]`, matching isn't limited to exact job titles. For example, excluding `intern` also excludes people with the job title `sales intern`. <br><br>The combined number of unique job titles in `person_titles[]` and `person_not_titles[]` must be less than 100. Requests that exceed this limit return a `422` error. <br><br>Examples: `intern`; `assistant` */
2345
+ "person_not_titles[]"?: string[];
2346
+ /** @description Exclude people who held any of these job titles in a previous role. Only past roles are checked; a person's current job title isn't affected by this filter. To exclude current job titles, use `person_not_titles[]`. <br><br>You can add fewer than 100 unique job titles. Requests that exceed this limit return a `422` error. <br><br>Examples: `intern`; `recruiter` */
2347
+ "person_not_past_titles[]"?: string[];
2348
+ /** @description A string of words over which we want to filter the results. */
2349
+ q_keywords?: string;
2350
+ /** @description The name of the person you want to find. Use this parameter to search by name only, independent of any other filters. Search results include people whose name contains all the words you enter. <br><br>Examples: `Jon Snow`; `Maria` */
2351
+ q_person_name?: string;
2352
+ /** @description The location where people live. You can search across cities, US states, countries, and postal codes (ZIP codes). Postal codes are supported for the United States, Germany, and the United Kingdom. To filter by a US ZIP code or a UK postcode, pass it on its own, such as `94105`. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>To find people based on the headquarters locations of their current employer, use the `organization_locations` parameter. <br><br>Examples: `california`; `ireland`; `chicago`; `94105`; `10115, germany` */
2353
+ "person_locations[]"?: string[];
2354
+ /** @description Exclude people from your search results based on where they live. You can use cities, US states, countries, and postal codes (ZIP codes) as locations to exclude. Postal codes are supported for the United States, Germany, and the United Kingdom. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>This is the counterpart to `person_locations[]`. To exclude people based on the headquarters location of their current employer, use the `organization_not_locations[]` parameter. <br><br>Examples: `texas`; `ireland`; `94105` */
2355
+ "person_not_locations[]"?: string[];
2356
+ /** @description The job seniority that people hold within their current employer. This enables you to find people that currently hold positions at certain reporting levels, such as Director level or senior IC level. <br><br>For a person to be included in search results, they only need to match 1 of the seniorities you add. Adding more seniorities expands your search results. <br><br> Searches only return results based on their current job title, so searching for Director-level employees only returns people that currently hold a Director-level title. If someone was previously a Director, but is currently a VP, they would not be included in your search results. <br><br>Use this parameter in combination with the `person_titles[]` parameter to find people based on specific job functions and seniority levels. <br><br>The following options can be used for this parameter: <br><ul><li><code>owner</code></li><li><code>founder</code></li><li><code>c_suite</code></li><li><code>partner</code></li><li><code>vp</code></li><li><code>head</code></li><li><code>director</code></li><li><code>manager</code></li><li><code>senior</code></li><li><code>entry</code></li><li><code>intern</code></li></ul> */
2357
+ "person_seniorities[]"?: string[];
2358
+ /** @description The location of the company headquarters for a person's current employer. You can search across cities, US states, countries, and postal codes (ZIP codes). Postal codes are supported for the United States, Germany, and the United Kingdom. To filter by a US ZIP code or a UK postcode, pass it on its own, such as `10017`. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>If a company has several office locations, results are still based on the headquarters location. For example, if you search `chicago` but a company's HQ location is in `boston`, people that work for the Boston-based company won't appear in your results, even if they match other parameters. <br><br>To find people based on their personal location, use the `person_locations` parameter. <br><br>Examples: `texas`; `tokyo`; `spain`; `10017`; `10115, germany` */
2359
+ "organization_locations[]"?: string[];
2360
+ /** @description Exclude people from your search results based on the headquarters location of their current employer. You can use cities, US states, countries, and postal codes (ZIP codes) as locations to exclude. Postal codes are supported for the United States, Germany, and the United Kingdom. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>This is the counterpart to `organization_locations[]`. To exclude people based on where they live, use the `person_not_locations[]` parameter. <br><br>Examples: `minnesota`; `ireland`; `10017` */
2361
+ "organization_not_locations[]"?: string[];
2362
+ /** @description The Apollo IDs for the industries of the person's current employer. For a person to be included in search results, their employer only needs to match one of the industries you add. <br><br>Each industry in the Apollo database has a unique ID. To find industry IDs, call the <a href="https://docs.apollo.io/reference/organization-enrichment">organization enrichment endpoint</a> for a company in the industry you want. The `industry_tag_id` field contains the ID of the company's primary industry, and the `industry_tag_hash` field maps each of the company's industry names to its ID. <br><br>To search by industry name instead of ID, use the `organization_industries[]` parameter. <br><br>Example: `5567cd4773696439b10b0000` */
2363
+ "organization_industry_tag_ids[]"?: string[];
2364
+ /** @description Exclude people whose current employer belongs to any of these industries, identified by Apollo industry ID. This is the counterpart to `organization_industry_tag_ids[]`. <br><br>To find industry IDs, refer to the `organization_industry_tag_ids[]` parameter. <br><br>Example: `5567cd4773696439b10b0000` */
2365
+ "organization_not_industry_tag_ids[]"?: string[];
2366
+ /** @description The industry names for the person's current employer. For a person to be included in search results, their employer only needs to match one of the industries you add. <br><br>Values must exactly match an Apollo industry name, including capitalization and punctuation. Apollo industry names are lowercase. Use the values that Apollo returns in the `industries` field of the <a href="https://docs.apollo.io/reference/organization-enrichment">organization enrichment endpoint</a>. Partial matches aren't supported. <br><br>To search by Apollo industry ID instead, use the `organization_industry_tag_ids[]` parameter. <br><br>Examples: `information technology & services`; `hospital & health care` */
2367
+ "organization_industries[]"?: string[];
2368
+ /** @description The North American Industry Classification System (NAICS) codes for the person's current employer. For a person to be included in search results, their employer only needs to match one of the codes you add. <br><br>Codes match by prefix, so a shorter code matches every code that starts with it. For example, `5415` matches `541511` and `541512`. You can also enter a range of codes separated by a hyphen. For example, `31-33` matches all codes that start with `31`, `32`, or `33`. <br><br>Examples: `541511`; `5415`; `31-33` */
2369
+ "organization_naics_codes[]"?: string[];
2370
+ /** @description Exclude people whose current employer matches any of these NAICS codes. This is the counterpart to `organization_naics_codes[]`, and uses the same prefix and range matching. <br><br>Examples: `92`; `31-33` */
2371
+ "not_organization_naics_codes[]"?: string[];
2372
+ /** @description The Standard Industrial Classification (SIC) codes for the person's current employer. For a person to be included in search results, their employer only needs to match one of the codes you add. <br><br>Codes match by prefix, so a shorter code matches every code that starts with it. For example, `73` matches `7371` and `7372`. Ranges aren't supported for SIC codes. <br><br>Examples: `7372`; `73` */
2373
+ "organization_sic_codes[]"?: string[];
2374
+ /** @description Exclude people whose current employer matches any of these SIC codes. This is the counterpart to `organization_sic_codes[]`, and uses the same prefix matching. <br><br>Examples: `91`; `7372` */
2375
+ "not_organization_sic_codes[]"?: string[];
2376
+ /** @description The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar. <br><br>This parameter accepts up to 1,000 domains in a single request. <br><br>Examples: `apollo.io`; `microsoft.com` */
2377
+ "q_organization_domains_list[]"?: string[];
2378
+ /** @description The email statuses for the people you want to find. You can add multiple statuses to expand your search. <br><br>The statuses you can search include: <ul> <li> <code>verified</code> </li> <li> <code>unverified</code> </li> <li> <code>likely to engage</code> </li> <li> <code>unavailable</code> </li> </ul> */
2379
+ "contact_email_status[]"?: string[];
2380
+ /** @description The Apollo IDs for the companies (employers) you want to include in your search results. Each company in the Apollo database is assigned a unique ID. <br><br>To find IDs, call the <a href="https://docs.apollo.io/reference/organization-search" target="_blank">organization search endpoint</a> and identify the values for `organization_id`. <br><br>Example: `5e66b6381e05b4008c8331b8` */
2381
+ "organization_ids[]"?: string[];
2382
+ /** @description The number range of employees working for the person's current company. This enables you to find people based on the headcount of their employer. You can add multiple ranges to expand your search results. <br><br>Each range you add needs to be a string, with the upper and lower numbers of the range separated only by a comma. <br><br>Examples: `1,10`; `250,500`; `10000,20000` */
2383
+ "organization_num_employees_ranges[]"?: string[];
2384
+ /** @description The minimum revenue the person's current employer generates. Use this parameter in combination with `revenue_range[max]` to set a revenue range. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `500000`; `1500000` */
2385
+ "revenue_range[min]"?: number;
2386
+ /** @description The maximum revenue the person's current employer generates. Use this parameter in combination with `revenue_range[min]` to set a revenue range. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `500000`; `1500000` */
2387
+ "revenue_range[max]"?: number;
2388
+ /** @description Find people based on all of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies. <br><br>Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by <a href="https://api.apollo.io/v1/auth/supported_technologies_csv" target="_blank">downloading this CSV file</a>. <br><br>Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file. <br><br>Examples: `salesforce`; `google_analytics`; `wordpress_org` */
2389
+ "currently_using_all_of_technology_uids[]"?: string[];
2390
+ /** @description Find people based on any of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies. <br><br>Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by <a href="https://api.apollo.io/v1/auth/supported_technologies_csv" target="_blank">downloading this CSV file</a>. <br><br>Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file. <br><br>Examples: `salesforce`; `google_analytics`; `wordpress_org` */
2391
+ "currently_using_any_of_technology_uids[]"?: string[];
2392
+ /** @description Exclude people from your search based on any of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies. <br><br>Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by <a href="https://api.apollo.io/v1/auth/supported_technologies_csv" target="_blank">downloading this CSV file</a>. <br><br>Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file. <br><br>Examples: `salesforce`; `google_analytics`; `wordpress_org` */
2393
+ "currently_not_using_any_of_technology_uids[]"?: string[];
2394
+ /** @description The job titles that are listed in active job postings at the person's current employer. <br><br>Examples: `sales manager`; `research analyst` */
2395
+ "q_organization_job_titles[]"?: string[];
2396
+ /** @description The locations of the jobs being actively recruited by the person's employer. <br><br>Examples: `atlanta`; `japan` */
2397
+ "organization_job_locations[]"?: string[];
2398
+ /** @description The minimum number of job postings active at the person's current employer. Use this parameter in combination with `organization_num_jobs_range[max]` to set a job postings range. <br><br>Examples: `50`; `500` */
2399
+ "organization_num_jobs_range[min]"?: number;
2400
+ /** @description The maximum number of job postings active at the person's current employer. Use this parameter in combination with `organization_num_jobs_range[min]` to set a job postings range. <br><br>Examples: `50`; `500` */
2401
+ "organization_num_jobs_range[max]"?: number;
2402
+ /** @description The earliest date when jobs were posted by the person's current employer. Use this parameter in combination with `organization_job_posted_at_range[max]` to set a date range for when jobs posted. <br><br>Example: `2025-07-25` */
2403
+ "organization_job_posted_at_range[min]"?: string;
2404
+ /** @description The latest date when jobs were posted by the person's current employer. Use this parameter in combination with `organization_job_posted_at_range[min]` to set a date range for when jobs posted. <br><br>Example: `2025-09-25` */
2405
+ "organization_job_posted_at_range[max]"?: string;
2406
+ /** @description The trailing window, in months, used to measure the headcount growth of the person's current employer. <br><br>Only `6`, `12`, and `24` are accepted. Any other value is ignored. <br><br>This parameter has no effect on its own. To filter by headcount growth, send it together with `organization_headcount_growth_range[min]`, `organization_headcount_growth_range[max]`, or both. If you send a window without a range, or a range without a window, the headcount growth filter is skipped and your results come back unfiltered. <br><br>Example: `6` */
2407
+ organization_headcount_growth_past_n_months?: 6 | 12 | 24;
2408
+ /** @description The minimum headcount growth at the person's current employer, as a percentage, over the window set by `organization_headcount_growth_past_n_months`. <br><br>Enter the percentage as a whole number, without a percent sign or decimal point: use `10` for 10% growth. This is a lower bound, so sending a minimum on its own returns every match at or above that figure. Negative values are accepted, but `-20` alone still includes flat and growing employers, because everything above -20% also matches. To isolate employers that shrank, pair a negative minimum with a negative maximum, such as a minimum of `-20` and a maximum of `-1`. <br><br>Use `organization_headcount_growth_range[max]` to set the upper bound of the range. You must also send `organization_headcount_growth_past_n_months`. <br><br>Examples: `10`; `50` */
2409
+ "organization_headcount_growth_range[min]"?: number;
2410
+ /** @description The maximum headcount growth at the person's current employer, as a percentage, over the window set by `organization_headcount_growth_past_n_months`. <br><br>Enter the percentage as a whole number, without a percent sign or decimal point: use `100` for 100% growth. <br><br>Use `organization_headcount_growth_range[min]` to set the lower bound of the range. You must also send `organization_headcount_growth_past_n_months`. <br><br>Examples: `100`; `250` */
2411
+ "organization_headcount_growth_range[max]"?: number;
2412
+ /** @description The Apollo IDs of the companies you want to use as lookalike seeds. Results are narrowed to people who work at companies similar to the ones you pass, and people at the seed companies themselves are excluded. <br><br>To find IDs, call the <a href="https://docs.apollo.io/reference/organization-search">organization search</a> endpoint and use the `id` value of each entry in the `organizations` array it returns. <br><br>Note the singular `organization` in the parameter name. <br><br>You can pass a maximum of five seed companies. Sending more returns a validation error. <br><br>If Apollo holds no lookalike data for a seed company, this filter returns no results rather than falling back to an unfiltered search, so an empty response can mean the seed is unusable rather than that no people match. If that happens, try a different or better-known seed company. <br><br>Example: `5e66b6381e05b4008c8331b8` */
2413
+ "lookalike_organization_ids[]"?: string[];
2414
+ /** @description Exclude people whose current employer matches any of these company domains. This is the counterpart to `q_organization_domains_list[]`. <br><br>Matching covers every domain Apollo holds for a company, not just the one you send, so excluding a single domain also excludes that company's other known domains. <br><br>Values are reduced to a domain before matching, so a bare domain, a full URL, or an email address at that domain all work. <br><br>Use this parameter to keep companies you already work with, or have already contacted, out of your results without retrieving and enriching them first. <br><br>Examples: `apollo.io`; `salesforce.com` */
2415
+ "not_organization_websites_list[]"?: string[];
2416
+ /** @description The page number of the Apollo data that you want to retrieve. <br><br>Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint. <br><br>Example: `4` */
2417
+ page?: number;
2418
+ /** @description The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. <br><br>Use the `page` parameter to search the different pages of data. <br><br>Example: `10` */
2419
+ per_page?: number;
2420
+ };
2421
+ header?: never;
2422
+ path?: never;
2423
+ cookie?: never;
2424
+ };
2425
+ requestBody?: never;
2426
+ responses: {
2427
+ /** @description 200 */
2428
+ 200: {
2429
+ headers: {
2430
+ [name: string]: unknown;
2431
+ };
2432
+ content: {
2433
+ "application/json": {
2434
+ /**
2435
+ * @description The total number of people that match your search criteria.
2436
+ * @example 2
2437
+ */
2438
+ total_entries?: number;
2439
+ /** @description An array of people that match your search criteria. */
2440
+ people?: {
2441
+ /**
2442
+ * @description The Apollo ID for the person.
2443
+ * @example 587cf802f65125cad923a266
2444
+ */
2445
+ id?: string;
2446
+ /**
2447
+ * @description The first name of the person.
2448
+ * @example John
2449
+ */
2450
+ first_name?: string;
2451
+ /**
2452
+ * @description The last name of the person with the middle characters obfuscated for privacy. The format shows the first 2 characters, followed by asterisks, and then the last character.
2453
+ * @example Do***e
2454
+ */
2455
+ last_name_obfuscated?: string;
2456
+ /**
2457
+ * @description The job title of the person. This field may be null if the person's title is not available.
2458
+ * @example VP of Sales
2459
+ */
2460
+ title?: string | null;
2461
+ /**
2462
+ * Format: date-time
2463
+ * @description The date and time when the person's data was last refreshed in Apollo's database.
2464
+ * @example 2024-01-15T10:30:00.000Z
2465
+ */
2466
+ last_refreshed_at?: string;
2467
+ /**
2468
+ * @description Indicates whether Apollo has a verified email address for this person.
2469
+ * @example true
2470
+ */
2471
+ has_email?: boolean;
2472
+ /**
2473
+ * @description Indicates whether Apollo has city location data for this person.
2474
+ * @example true
2475
+ */
2476
+ has_city?: boolean;
2477
+ /**
2478
+ * @description Indicates whether Apollo has state location data for this person.
2479
+ * @example true
2480
+ */
2481
+ has_state?: boolean;
2482
+ /**
2483
+ * @description Indicates whether Apollo has country location data for this person.
2484
+ * @example true
2485
+ */
2486
+ has_country?: boolean;
2487
+ /**
2488
+ * @description Indicates whether Apollo has direct phone number data for this person. Returns `Yes` if available, or `Maybe: please request direct dial via people/bulk_match` if uncertain.
2489
+ * @example Yes
2490
+ */
2491
+ has_direct_phone?: string;
2492
+ /** @description Information about the person's current employer organization. */
2493
+ organization?: {
2494
+ /**
2495
+ * @description The name of the organization.
2496
+ * @example Apollo.io
2497
+ */
2498
+ name?: string;
2499
+ /**
2500
+ * @description Indicates whether Apollo has industry classification data for this organization.
2501
+ * @example true
2502
+ */
2503
+ has_industry?: boolean;
2504
+ /**
2505
+ * @description Indicates whether Apollo has phone number data for this organization.
2506
+ * @example true
2507
+ */
2508
+ has_phone?: boolean;
2509
+ /**
2510
+ * @description Indicates whether Apollo has city location data for the organization's headquarters.
2511
+ * @example true
2512
+ */
2513
+ has_city?: boolean;
2514
+ /**
2515
+ * @description Indicates whether Apollo has state location data for the organization's headquarters.
2516
+ * @example true
2517
+ */
2518
+ has_state?: boolean;
2519
+ /**
2520
+ * @description Indicates whether Apollo has country location data for the organization's headquarters.
2521
+ * @example true
2522
+ */
2523
+ has_country?: boolean;
2524
+ /**
2525
+ * @description Indicates whether Apollo has postal/zip code data for the organization's headquarters.
2526
+ * @example true
2527
+ */
2528
+ has_zip_code?: boolean;
2529
+ /**
2530
+ * @description Indicates whether Apollo has revenue data for this organization.
2531
+ * @example true
2532
+ */
2533
+ has_revenue?: boolean;
2534
+ /**
2535
+ * @description Indicates whether Apollo has employee count data for this organization.
2536
+ * @example true
2537
+ */
2538
+ has_employee_count?: boolean;
2539
+ };
2540
+ }[];
2541
+ };
2542
+ };
2543
+ };
2544
+ /** @description 401 */
2545
+ 401: {
2546
+ headers: {
2547
+ [name: string]: unknown;
2548
+ };
2549
+ content: {
2550
+ "text/plain": unknown;
2551
+ };
2552
+ };
2553
+ /** @description 403 */
2554
+ 403: {
2555
+ headers: {
2556
+ [name: string]: unknown;
2557
+ };
2558
+ content: {
2559
+ "application/json": {
2560
+ error_details?: components["schemas"]["ErrorDetails"];
2561
+ /**
2562
+ * @deprecated
2563
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2564
+ * @example This API key is not authorized to access api/v1/mixed_people/api_search. Request an API key from your administrator that includes this endpoint in its configured scope.
2565
+ */
2566
+ error?: string;
2567
+ /**
2568
+ * @deprecated
2569
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2570
+ * @example API_INACCESSIBLE
2571
+ */
2572
+ error_code?: string;
2573
+ };
2574
+ };
2575
+ };
2576
+ /** @description 422 */
2577
+ 422: {
2578
+ headers: {
2579
+ [name: string]: unknown;
2580
+ };
2581
+ content: {
2582
+ "application/json": {
2583
+ error_details?: components["schemas"]["ErrorDetails"];
2584
+ /**
2585
+ * @deprecated
2586
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2587
+ * @example Invalid search parameters provided.
2588
+ */
2589
+ error?: string;
2590
+ };
2591
+ };
2592
+ };
2593
+ /** @description 429 */
2594
+ 429: {
2595
+ headers: {
2596
+ [name: string]: unknown;
2597
+ };
2598
+ content: {
2599
+ "application/json": {
2600
+ error_details?: components["schemas"]["ErrorDetails"];
2601
+ /**
2602
+ * @deprecated
2603
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2604
+ * @example The maximum number of api calls allowed for api/v1/mixed_people/api_search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
2605
+ */
2606
+ message?: string;
2607
+ };
2608
+ };
2609
+ };
2610
+ };
2611
+ };
2612
+ "organization-search": {
2613
+ parameters: {
2614
+ query?: {
2615
+ /** @description The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar. <br><br>This parameter accepts up to 1,000 domains in a single request. <br><br>Examples: `apollo.io`; `microsoft.com` */
2616
+ "q_organization_domains_list[]"?: string[];
2617
+ /** @description The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results. <br><br>Each range you add needs to be a string, with the upper and lower numbers of the range separated only by a comma. <br><br>Examples: `1,10`; `250,500`; `10000,20000` */
2618
+ "organization_num_employees_ranges[]"?: string[];
2619
+ /** @description The location of the company headquarters. You can search across cities, US states, countries, and postal codes (ZIP codes). Postal codes are supported for the United States, Germany, and the United Kingdom. To filter by a US ZIP code or a UK postcode, pass it on its own, such as `10017`. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>If a company has several office locations, results are still based on the headquarters location. For example, if you search `chicago` but a company's HQ location is in `boston`, any Boston-based companies won't appearch in your search results, even if they match other parameters.. <br><br>To exclude companies based on location, use the `organization_not_locations` parameter. <br><br>Examples: `texas`; `tokyo`; `spain`; `10017`; `10115, germany` */
2620
+ "organization_locations[]"?: string[];
2621
+ /** @description Exclude companies from search results based on the location of the company headquarters. You can use cities, US states, countries, and postal codes (ZIP codes) as locations to exclude. Postal codes are supported for the United States, Germany, and the United Kingdom. For a German postal code, add the country, such as `10115, germany`, because a five-digit code on its own can match a US ZIP code instead. <br><br>This parameter is useful for ensuring you do not prospect in an undesirable territory. For example, if you use `ireland` as a value, no Ireland-based companies appear in your search results. <br><br>Examples: `minnesota`; `ireland`; `seoul` */
2622
+ "organization_not_locations[]"?: string[];
2623
+ /** @description The Apollo IDs for the industries of the companies you want to find. For a company to be included in search results, it only needs to match one of the industries you add. <br><br>Each industry in the Apollo database has a unique ID. To find industry IDs, call the <a href="https://docs.apollo.io/reference/organization-enrichment">organization enrichment endpoint</a> for a company in the industry you want. The `industry_tag_id` field contains the ID of the company's primary industry, and the `industry_tag_hash` field maps each of the company's industry names to its ID. <br><br>To search by industry name instead of ID, use the `organization_industries[]` parameter. <br><br>Example: `5567cd4773696439b10b0000` */
2624
+ "organization_industry_tag_ids[]"?: string[];
2625
+ /** @description Exclude companies that belong to any of these industries, identified by Apollo industry ID. This is the counterpart to `organization_industry_tag_ids[]`. <br><br>To find industry IDs, refer to the `organization_industry_tag_ids[]` parameter. <br><br>Example: `5567cd4773696439b10b0000` */
2626
+ "organization_not_industry_tag_ids[]"?: string[];
2627
+ /** @description The industry names for the companies you want to find. For a company to be included in search results, it only needs to match one of the industries you add. <br><br>Values must exactly match an Apollo industry name, including capitalization and punctuation. Apollo industry names are lowercase. Use the values that Apollo returns in the `industries` field of the <a href="https://docs.apollo.io/reference/organization-enrichment">organization enrichment endpoint</a>. Partial matches aren't supported. <br><br>To search by Apollo industry ID instead, use the `organization_industry_tag_ids[]` parameter. <br><br>Examples: `information technology & services`; `hospital & health care` */
2628
+ "organization_industries[]"?: string[];
2629
+ /** @description The North American Industry Classification System (NAICS) codes for the companies you want to find. For a company to be included in search results, it only needs to match one of the codes you add. <br><br>Codes match by prefix, so a shorter code matches every code that starts with it. For example, `5415` matches `541511` and `541512`. You can also enter a range of codes separated by a hyphen. For example, `31-33` matches all codes that start with `31`, `32`, or `33`. <br><br>Examples: `541511`; `5415`; `31-33` */
2630
+ "organization_naics_codes[]"?: string[];
2631
+ /** @description Exclude companies that match any of these NAICS codes. This is the counterpart to `organization_naics_codes[]`, and uses the same prefix and range matching. <br><br>Examples: `92`; `31-33` */
2632
+ "not_organization_naics_codes[]"?: string[];
2633
+ /** @description The Standard Industrial Classification (SIC) codes for the companies you want to find. For a company to be included in search results, it only needs to match one of the codes you add. <br><br>Codes match by prefix, so a shorter code matches every code that starts with it. For example, `73` matches `7371` and `7372`. Ranges aren't supported for SIC codes. <br><br>Examples: `7372`; `73` */
2634
+ "organization_sic_codes[]"?: string[];
2635
+ /** @description Exclude companies that match any of these SIC codes. This is the counterpart to `organization_sic_codes[]`, and uses the same prefix matching. <br><br>Examples: `91`; `7372` */
2636
+ "not_organization_sic_codes[]"?: string[];
2637
+ /** @description Search for organizations based on their revenue. <br><br>Use this parameter to set the lower range of organization revenue. Use the `revenue_range[max]` parameter to set the upper range of revenue. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Example: `300000` */
2638
+ "revenue_range[min]"?: number;
2639
+ /** @description Search for organizations based on their revenue. <br><br>Use this parameter to set the upper range of organization revenue. Use the `revenue_range[min]` parameter to set the lower range of revenue. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Example: `50000000` */
2640
+ "revenue_range[max]"?: number;
2641
+ /** @description Find organizations based on the technologies they currently use. Apollo supports filtering by 1,500+ technologies. <br><br>Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by <a href="https://api.apollo.io/v1/auth/supported_technologies_csv" target="_blank">downloading this CSV file</a>. <br><br>Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file. <br><br>Examples: `salesforce`; `google_analytics`; `wordpress_org` */
2642
+ "currently_using_any_of_technology_uids[]"?: string[];
2643
+ /** @description Filter search results based on keywords associated with companies. For example, you can enter `mining` as a value to return only companies that have an association with the mining industry. <br><br>Examples: `mining`; `sales strategy`; `consulting` */
2644
+ "q_organization_keyword_tags[]"?: string[];
2645
+ /** @description Exclude companies associated with any of these keywords. This is the counterpart to `q_organization_keyword_tags[]`. <br><br>Each value is matched as an exact phrase against a company's keywords, name, and short description. Matching isn't case-sensitive. A company that matches any of the values you add is excluded. For example, `staffing` excludes companies that have `staffing` as a keyword or in their name or description. <br><br>You can add up to 150 keywords. <br><br>Examples: `staffing`; `recruiting` */
2646
+ "q_not_organization_keyword_tags[]"?: string[];
2647
+ /** @description Filter search results to include a specific company name. <br><br>If the value you enter for this parameter does not match with a company's name, the company will not appear in search results, even if it matches other parameters. Partial matches are accepted. For example, if you filter by the value `marketing`, a company called `NY Marketing Unlimited` would still be eligible as a search result, but `NY Market Analysis` would not be eligible. <br><br>Example: `apollo` or `mining` */
2648
+ q_organization_name?: string;
2649
+ /** @description The Apollo IDs for the companies you want to include in your search results. Each company in the Apollo database is assigned a unique ID. <br><br>To find IDs, identify the values for `organization_id` when you call this endpoint. <br><br>Example: `5e66b6381e05b4008c8331b8` */
2650
+ "organization_ids[]"?: string[];
2651
+ /** @description The minimum amount the company received with its most recent funding round. Use this parameter in combination with `latest_funding_amount_range[max]` to set a monetary range for the company's most recent funding round. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `5000000`; `15000000` */
2652
+ "latest_funding_amount_range[min]"?: number;
2653
+ /** @description The maximium amount the company received with its most recent funding round. Use this parameter in combination with `latest_funding_amount_range[min]` to set a monetary range for the company's most recent funding round. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `5000000`; `15000000` */
2654
+ "latest_funding_amount_range[max]"?: number;
2655
+ /** @description The minimum amount the company received during all of its funding rounds combined. Use this parameter in combination with `total_funding_range[max]` to set a monetary range for all of the company's funding rounds. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `50000000`; `350000000` */
2656
+ "total_funding_range[min]"?: number;
2657
+ /** @description The maximum amount the company received during all of its funding rounds combined. Use this parameter in combination with `total_funding_range[min]` to set a monetary range for all of the company's funding rounds. <br><br>Do not enter currency symbols, commas, or decimal points in the figure. <br><br>Examples: `50000000`; `350000000` */
2658
+ "total_funding_range[max]"?: number;
2659
+ /** @description The earliest date when the company received its most recent funding round. Use this parameter in combination with `latest_funding_date_range[max]` to set a date range for when the company received its most recent funding round. <br><br>Example: `2025-07-25` */
2660
+ "latest_funding_date_range[min]"?: string;
2661
+ /** @description The latest date when the company received its most recent funding round. Use this parameter in combination with `latest_funding_date_range[min]` to set a date range for when the company received its most recent funding round. <br><br>Example: `2025-09-25` */
2662
+ "latest_funding_date_range[max]"?: string;
2663
+ /** @description The job titles that are listed in active job postings at the company. <br><br>Examples: `sales manager`; `research analyst` */
2664
+ "q_organization_job_titles[]"?: string[];
2665
+ /** @description The locations of the jobs being actively recruited by the company. <br><br>Examples: `atlanta`; `japan` */
2666
+ "organization_job_locations[]"?: string[];
2667
+ /** @description The minimum number of job postings active at the company. Use this parameter in combination with `organization_num_jobs_range[max]` to set a job postings range. <br><br>Examples: `50`; `500` */
2668
+ "organization_num_jobs_range[min]"?: number;
2669
+ /** @description The maximum number of job postings active at the company. Use this parameter in combination with `organization_num_jobs_range[min]` to set a job postings range. <br><br>Examples: `50`; `500` */
2670
+ "organization_num_jobs_range[max]"?: number;
2671
+ /** @description The earliest date when jobs were posted by the company. Use this parameter in combination with `organization_job_posted_at_range[max]` to set a date range for when jobs posted. <br><br>Example: `2025-07-25` */
2672
+ "organization_job_posted_at_range[min]"?: string;
2673
+ /** @description The latest date when jobs were posted by the company. Use this parameter in combination with `organization_job_posted_at_range[min]` to set a date range for when jobs posted. <br><br>Example: `2025-09-25` */
2674
+ "organization_job_posted_at_range[max]"?: string;
2675
+ /** @description The trailing window, in months, used to measure company headcount growth. <br><br>Only `6`, `12`, and `24` are accepted. Any other value is ignored. <br><br>This parameter has no effect on its own. To filter by headcount growth, send it together with `organization_headcount_growth_range[min]`, `organization_headcount_growth_range[max]`, or both. If you send a window without a range, or a range without a window, the headcount growth filter is skipped and your results come back unfiltered. <br><br>Example: `6` */
2676
+ organization_headcount_growth_past_n_months?: 6 | 12 | 24;
2677
+ /** @description The minimum company headcount growth, as a percentage, over the window set by `organization_headcount_growth_past_n_months`. <br><br>Enter the percentage as a whole number, without a percent sign or decimal point: use `10` for 10% growth. This is a lower bound, so sending a minimum on its own returns every match at or above that figure. Negative values are accepted, but `-20` alone still includes flat and growing companies, because everything above -20% also matches. To isolate companies that shrank, pair a negative minimum with a negative maximum, such as a minimum of `-20` and a maximum of `-1`. <br><br>Use `organization_headcount_growth_range[max]` to set the upper bound of the range. You must also send `organization_headcount_growth_past_n_months`. <br><br>Examples: `10`; `50` */
2678
+ "organization_headcount_growth_range[min]"?: number;
2679
+ /** @description The maximum company headcount growth, as a percentage, over the window set by `organization_headcount_growth_past_n_months`. <br><br>Enter the percentage as a whole number, without a percent sign or decimal point: use `100` for 100% growth. <br><br>Use `organization_headcount_growth_range[min]` to set the lower bound of the range. You must also send `organization_headcount_growth_past_n_months`. <br><br>Examples: `100`; `250` */
2680
+ "organization_headcount_growth_range[max]"?: number;
2681
+ /** @description The Apollo IDs of the companies you want to use as lookalike seeds. Results are narrowed and ranked by similarity to the companies you pass, and the seed companies themselves are excluded from results. <br><br>To find IDs, use the `id` value of each entry in the `organizations` array this endpoint returns. <br><br>Note the singular `organization` in the parameter name. <br><br>You can pass a maximum of five seed companies. Sending more returns a validation error. <br><br>If Apollo holds no lookalike data for a seed company, this filter returns no results rather than falling back to an unfiltered search, so an empty response can mean the seed is unusable rather than that no companies match. If that happens, try a different or better-known seed company. <br><br>Example: `5e66b6381e05b4008c8331b8` */
2682
+ "lookalike_organization_ids[]"?: string[];
2683
+ /** @description Exclude companies that match any of these domains. This is the counterpart to `q_organization_domains_list[]`. <br><br>Matching covers every domain Apollo holds for a company, not just the one you send, so excluding a single domain also excludes that company's other known domains. <br><br>Values are reduced to a domain before matching, so a bare domain, a full URL, or an email address at that domain all work. <br><br>Use this parameter to keep companies you already work with, or have already contacted, out of your results without retrieving and enriching them first. <br><br>Examples: `apollo.io`; `salesforce.com` */
2684
+ "not_organization_websites_list[]"?: string[];
2685
+ /** @description The page number of the Apollo data that you want to retrieve. <br><br>Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint. <br><br>Example: `4` */
2686
+ page?: number;
2687
+ /** @description The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. <br><br>Use the `page` parameter to search the different pages of data. <br><br>Example: `10` */
2688
+ per_page?: number;
2689
+ };
2690
+ header?: never;
2691
+ path?: never;
2692
+ cookie?: never;
2693
+ };
2694
+ requestBody?: never;
2695
+ responses: {
2696
+ /** @description 200 */
2697
+ 200: {
2698
+ headers: {
2699
+ [name: string]: unknown;
2700
+ };
2701
+ content: {
2702
+ "application/json": {
2703
+ breadcrumbs?: {
2704
+ /** @example # Employees */
2705
+ label?: string;
2706
+ /** @example organization_num_employees_ranges */
2707
+ signal_field_name?: string;
2708
+ /** @example 250,1000 */
2709
+ value?: string;
2710
+ /** @example 250-1000 */
2711
+ display_name?: string;
2712
+ }[];
2713
+ /**
2714
+ * @default true
2715
+ * @example false
2716
+ */
2717
+ partial_results_only?: boolean;
2718
+ /**
2719
+ * @default true
2720
+ * @example false
2721
+ */
2722
+ has_join?: boolean;
2723
+ /**
2724
+ * @default true
2725
+ * @example false
2726
+ */
2727
+ disable_eu_prospecting?: boolean;
2728
+ /**
2729
+ * @default 0
2730
+ * @example 10000
2731
+ */
2732
+ partial_results_limit?: number;
2733
+ pagination?: {
2734
+ /**
2735
+ * @default 0
2736
+ * @example 1
2737
+ */
2738
+ page?: number;
2739
+ /**
2740
+ * @default 0
2741
+ * @example 2
2742
+ */
2743
+ per_page?: number;
2744
+ /**
2745
+ * @default 0
2746
+ * @example 1184
2747
+ */
2748
+ total_entries?: number;
2749
+ /**
2750
+ * @default 0
2751
+ * @example 592
2752
+ */
2753
+ total_pages?: number;
2754
+ };
2755
+ accounts?: unknown[];
2756
+ organizations?: {
2757
+ /** @example 615d029256de500001bdb460 */
2758
+ id?: string;
2759
+ /** @example Nikkei Asia */
2760
+ name?: string;
2761
+ /** @example http://www.nikkei.com */
2762
+ website_url?: string;
2763
+ blog_url?: unknown;
2764
+ angellist_url?: unknown;
2765
+ /** @example http://www.linkedin.com/company/nikkeiasia */
2766
+ linkedin_url?: string;
2767
+ /** @example https://twitter.com/nikkei */
2768
+ twitter_url?: string;
2769
+ /** @example https://facebook.com/nikkei */
2770
+ facebook_url?: string;
2771
+ primary_phone?: {
2772
+ /** @example +81 576-95-0781 */
2773
+ number?: string;
2774
+ /** @example Scraped */
2775
+ source?: string;
2776
+ /** @example +81576950781 */
2777
+ sanitized_number?: string;
2778
+ };
2779
+ languages?: string[];
2780
+ /**
2781
+ * @default 0
2782
+ * @example 1583
2783
+ */
2784
+ alexa_ranking?: number;
2785
+ /** @example +81 576-95-0781 */
2786
+ phone?: string;
2787
+ /** @example 3335963 */
2788
+ linkedin_uid?: string;
2789
+ /**
2790
+ * @default 0
2791
+ * @example 1876
2792
+ */
2793
+ founded_year?: number;
2794
+ publicly_traded_symbol?: unknown;
2795
+ publicly_traded_exchange?: unknown;
2796
+ /** @example https://zenprospect-production.s3.amazonaws.com/uploads/pictures/ff63c201695aca418dd88bd9/picture */
2797
+ logo_url?: string;
2798
+ crunchbase_url?: unknown;
2799
+ /** @example nikkei.com */
2800
+ primary_domain?: string;
2801
+ /** @description The North American Industry Classification System (NAICS) codes for the company. This field is only included when Apollo has NAICS codes for the company. */
2802
+ naics_codes?: string[];
2803
+ /** @description The Standard Industrial Classification (SIC) codes for the company. This field is only included when Apollo has SIC codes for the company. */
2804
+ sic_codes?: string[];
2805
+ /** @example +81576950781 */
2806
+ sanitized_phone?: string;
2807
+ owned_by_organization_id?: unknown;
2808
+ /**
2809
+ * @default true
2810
+ * @example true
2811
+ */
2812
+ show_intent?: boolean;
2813
+ /**
2814
+ * @default true
2815
+ * @example false
2816
+ */
2817
+ has_intent_signal_account?: boolean;
2818
+ intent_signal_account?: unknown;
2819
+ }[];
2820
+ model_ids?: string[];
2821
+ num_fetch_result?: unknown;
2822
+ derived_params?: unknown;
2823
+ };
2824
+ };
2825
+ };
2826
+ /** @description 401 */
2827
+ 401: {
2828
+ headers: {
2829
+ [name: string]: unknown;
2830
+ };
2831
+ content: {
2832
+ "text/plain": unknown;
2833
+ };
2834
+ };
2835
+ /** @description 403 */
2836
+ 403: {
2837
+ headers: {
2838
+ [name: string]: unknown;
2839
+ };
2840
+ content: {
2841
+ "application/json": {
2842
+ error_details?: components["schemas"]["ErrorDetails"];
2843
+ /**
2844
+ * @deprecated
2845
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2846
+ * @example This endpoint is only available to Apollo users on paid plans.
2847
+ */
2848
+ message?: string;
2849
+ };
2850
+ };
2851
+ };
2852
+ /** @description 429 */
2853
+ 429: {
2854
+ headers: {
2855
+ [name: string]: unknown;
2856
+ };
2857
+ content: {
2858
+ "application/json": {
2859
+ error_details?: components["schemas"]["ErrorDetails"];
2860
+ /**
2861
+ * @deprecated
2862
+ * @description Legacy error field. Removed on 2027-02-16, after which `error_details` is the only error payload.
2863
+ * @example The maximum number of api calls allowed for api/v1/mixed_companies/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.
2864
+ */
2865
+ message?: string;
2866
+ };
2867
+ };
2868
+ };
2869
+ };
2870
+ };
2871
+ "get-current-user-profile": {
2872
+ parameters: {
2873
+ query?: {
2874
+ /** @description Set to `true` to include credit usage and remaining credit details (lead, direct dial, export, AI, and power-up credits) in the response. Accepts boolean (`true`/`false`) or string (`"true"`/`"false"`) values. Defaults to `false`. <br><br>Example: `true` */
2875
+ include_credit_usage?: boolean;
2876
+ };
2877
+ header?: never;
2878
+ path?: never;
2879
+ cookie?: never;
2880
+ };
2881
+ requestBody?: never;
2882
+ responses: {
2883
+ /** @description 200 */
2884
+ 200: {
2885
+ headers: {
2886
+ [name: string]: unknown;
2887
+ };
2888
+ content: {
2889
+ "application/json": {
2890
+ /** @example 66c8db577ed7f201b25c0eef */
2891
+ id?: string;
2892
+ /** @example 6095a710bd01d100a506d4ac */
2893
+ team_id?: string;
2894
+ /** @example John */
2895
+ first_name?: string;
2896
+ /** @example Doe */
2897
+ last_name?: string;
2898
+ /** @example Developer */
2899
+ title?: string;
2900
+ /** @example john.doe@example.com */
2901
+ email?: string;
2902
+ /**
2903
+ * @description Remaining lead credits for the user. Only present when `include_credit_usage=true`.
2904
+ * @example 9500
2905
+ */
2906
+ num_credits_remaining?: number;
2907
+ /**
2908
+ * @description Effective lead credit allowance for the user. Only present when `include_credit_usage=true`.
2909
+ * @example 10000
2910
+ */
2911
+ effective_num_lead_credits?: number;
2912
+ /**
2913
+ * @description Lead credits used by the user. Only present when `include_credit_usage=true`.
2914
+ * @example 500
2915
+ */
2916
+ num_lead_credits_used?: number;
2917
+ /**
2918
+ * @description Effective direct dial credit allowance for the user. Only present when `include_credit_usage=true`.
2919
+ * @example 1000
2920
+ */
2921
+ effective_num_direct_dial_credits?: number;
2922
+ /**
2923
+ * @description Direct dial credits used by the user. Only present when `include_credit_usage=true`.
2924
+ * @example 120
2925
+ */
2926
+ num_direct_dial_credits_used?: number;
2927
+ /**
2928
+ * @description Effective export credit allowance for the user. Only present when `include_credit_usage=true`.
2929
+ * @example 5000
2930
+ */
2931
+ effective_num_export_credits?: number;
2932
+ /**
2933
+ * @description Export credits used by the user. Only present when `include_credit_usage=true`.
2934
+ * @example 250
2935
+ */
2936
+ num_export_credits_used?: number;
2937
+ /**
2938
+ * @description Effective AI credit allowance for the user. Only present when `include_credit_usage=true`.
2939
+ * @example 2000
2940
+ */
2941
+ effective_num_ai_credits?: number;
2942
+ /**
2943
+ * @description AI credits used by the user. Only present when `include_credit_usage=true`.
2944
+ * @example 75
2945
+ */
2946
+ num_ai_credits_used?: number;
2947
+ /**
2948
+ * @description Effective power-up credit allowance for the team. Only present when `include_credit_usage=true`.
2949
+ * @example 1000
2950
+ */
2951
+ effective_num_power_up_credits?: number;
2952
+ /**
2953
+ * @description Power-up credits used (user this cycle on unified credits, otherwise team total). Only present when `include_credit_usage=true`.
2954
+ * @example 40
2955
+ */
2956
+ num_power_up_credits_used?: number;
2957
+ /**
2958
+ * @description Sum of lead, direct dial, export, and power-up credits used. Only present when `include_credit_usage=true` and the team is on unified credits.
2959
+ * @example 910
2960
+ */
2961
+ total_unified_credits_used?: number;
2962
+ };
2963
+ };
2964
+ };
2965
+ /** @description 401 */
2966
+ 401: {
2967
+ headers: {
2968
+ [name: string]: unknown;
2969
+ };
2970
+ content: {
2971
+ "text/plain": unknown;
2972
+ };
2973
+ };
2974
+ };
2975
+ };
2976
+ }
2977
+ //# sourceMappingURL=openapi.d.ts.map