> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# GetProspect API reference

> API reference for the GetProspect plugin in Corsair: every `getprospect.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Account

### meGet

`account.meGet`

Get Current User. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.account.meGet({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   email: string | null,
>   pending_email: string | null,
>   first_name: string | null,
>   last_name: string | null,
>   phone: string | null,
>   country: string | null,
>   timezone: string | null,
>   profile_photo: string | null,
>   linkedin_url: string | null,
>   email_verified: boolean,
>   phone_verified: boolean,
>   status: allowed_payment | not_allowed_payment | blocked | pending_review | permanently_deleted | russian_suspended | pending_phone_verification | null,
>   created_at: string | null,
>   workspace: {
>     id: number,
>     name: string | null,
>     role: admin | member
>   } | null,
>   auth: {
>     channel: app | extension | sheets | api | system | mcp,
>     api_key_id: string | null,
>     session_id: string | null
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Billing

### creditsGet

`billing.creditsGet`

Get Credit Balances. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.billing.creditsGet({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email_search: {
>     available: number,
>     allowance: number,
>     additional: number,
>     permanent: number
>   },
>   email_verification: {
>     available: number,
>     allowance: number,
>     additional: number,
>     permanent: number
>   },
>   phone_search: {
>     available: number,
>     allowance: number,
>     additional: number,
>     permanent: number
>   },
>   reset_at: string | null,
>   wallet?: {
>     balance: number,
>     plan_credit: number,
>     top_up: number,
>     plan_credit_renews_at: string | null,
>     auto_top_up_enabled: boolean,
>     prices: {
>       phone: number,
>       verification: number
>     },
>     top_up_url: string
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### subscriptionGet

`billing.subscriptionGet`

Get Subscription. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.billing.subscriptionGet({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object \| null` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   status: active | pause | disabled,
>   plan: {
>     id: string,
>     name: string | null,
>     price: number | null,
>     currency: string | null,
>     is_custom: boolean,
>     credits: {
>       email_search: number,
>       email_verification: number,
>       phone_search: number
>     },
>     wallet_plan_credit: boolean
>   } | null,
>   quantity: number,
>   billing_cycle: {
>     id: string,
>     name: string | null,
>     period: string | null,
>     discount: number | null
>   } | null,
>   started_at: string | null,
>   expires_at: string | null,
>   next_plan: {
>     id: string,
>     name: string | null,
>     price: number | null,
>     currency: string | null,
>     is_custom: boolean,
>     credits: {
>       email_search: number,
>       email_verification: number,
>       phone_search: number
>     },
>     wallet_plan_credit: boolean
>   } | null,
>   phone_addon: {
>     status: active | pause | disabled | null,
>     plan: {
>       id: string,
>       name: string | null,
>       price: number | null,
>       currency: string | null,
>       is_custom: boolean,
>       credits: {
>         email_search: number,
>         email_verification: number,
>         phone_search: number
>       },
>       wallet_plan_credit: boolean
>     } | null,
>     quantity: number
>   },
>   pause: {
>     started_at: string | null,
>     period_months: number | null,
>     discount_percent: number | null,
>     resumes_at: string | null
>   } | null,
>   discount: {
>     percent: number,
>     status: string | null,
>     months_left: number | null
>   } | null,
>   payer: individual | company | null,
>   gateway: stripe | fastspring | null
> } | null
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### usageSummaryGet

`billing.usageSummaryGet`

Get Usage Summary. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.billing.usageSummaryGet({
	query: {
		from: '2026-01-01',
		to: '2026-01-01',
		users: '64f1a2b3c4d5e6f7a8b9c0d1',
		channel: 'app',
		action: 'search',
		entity: 'people',
		group_by: 'day',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | Yes | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   from: string,
>   to: string,
>   users?: string,
>   channel?: app | extension | sheets | api | mcp,
>   action?: search | enrich | enrichment | save | export | csv_enrichment | email_verify | other,
>   entity?: people | companies,
>   group_by: day | source
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   totals: {
>     email_search: number,
>     email_verification: number,
>     phone_search: number,
>     email_credits: number,
>     verification_credits: number,
>     phone_credits: number,
>     searches: number,
>     enriches: number,
>     people_searches: number,
>     company_searches: number,
>     people_enriches: number,
>     company_enriches: number,
>     email_finds: number,
>     total_credits: number
>   },
>   series: {
>     key: string,
>     channel?: string,
>     action?: string,
>     entity?: string,
>     email_search: number,
>     email_verification: number,
>     phone_search: number,
>     email_credits: number,
>     verification_credits: number,
>     phone_credits: number,
>     searches: number,
>     enriches: number,
>     people_searches: number,
>     company_searches: number,
>     people_enriches: number,
>     company_enriches: number,
>     email_finds: number
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Blocklist

### companiesAdd

`blocklist.companiesAdd`

Block Companies. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.blocklist.companiesAdd({
	body: {
		data: [{ domain: 'x' }],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     domain: string,
>     identifier?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   added: {
>     identifiers: string[],
>     blocked_company: {
>       id: string,
>       domain: string,
>       created_at: string | null
>     }
>   }[],
>   already_blocked: {
>     identifiers: string[],
>     blocked_company: {
>       id: string,
>       domain: string,
>       created_at: string | null
>     }
>   }[],
>   invalid: {
>     identifier: string,
>     code: missing_field | invalid_format | wrong_type | out_of_range,
>     field: string | null,
>     reason: string
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   added_count: number,
>   already_blocked_count: number,
>   invalid_count: number
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### companiesDelete

`blocklist.companiesDelete`

Unblock Company. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.blocklist.companiesDelete({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   deleted_ids: string[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### companiesList

`blocklist.companiesList`

List Blocked Companies. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.blocklist.companiesList({
	query: { query: 'xx', page: 1, per_page: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   query?: string,
>   page?: number,
>   per_page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   domain: string,
>   created_at: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleAdd

`blocklist.peopleAdd`

Block People. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.blocklist.peopleAdd({
	body: {
		data: [{ first_name: 'x', last_name: 'x' }],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     first_name: string,
>     last_name: string,
>     linkedin_url?: string,
>     identifier?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   added: {
>     identifiers: string[],
>     blocked_person: {
>       id: string,
>       first_name: string,
>       last_name: string,
>       linkedin_url: string | null,
>       company_domain: string | null,
>       created_at: string | null
>     }
>   }[],
>   already_blocked: {
>     identifiers: string[],
>     blocked_person: {
>       id: string,
>       first_name: string,
>       last_name: string,
>       linkedin_url: string | null,
>       company_domain: string | null,
>       created_at: string | null
>     }
>   }[],
>   invalid: {
>     identifier: string,
>     code: missing_field | invalid_format | wrong_type | out_of_range,
>     field: string | null,
>     reason: string
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   added_count: number,
>   already_blocked_count: number,
>   invalid_count: number
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleDelete

`blocklist.peopleDelete`

Unblock Person. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.blocklist.peopleDelete({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   deleted_ids: string[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleList

`blocklist.peopleList`

List Blocked People. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.blocklist.peopleList({
	query: { query: 'xx', page: 1, per_page: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   query?: string,
>   page?: number,
>   per_page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   first_name: string,
>   last_name: string,
>   linkedin_url: string | null,
>   company_domain: string | null,
>   created_at: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Companies

### bulkEnrich

`companies.bulkEnrich`

Companies Bulk Enrich. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.companies.bulkEnrich({
	body: {
		data: [{}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     identifier?: string,
>     id?: string,
>     linkedin_id?: string | number,
>     linkedin_url?: string,
>     domain?: string,
>     name?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   matched: {
>     identifier: string,
>     matched_by: id | linkedin_id | linkedin_url | domain | name | name_search,
>     company: {
>       id: string,
>       name: string | null,
>       description: string | null,
>       logo: string | null,
>       website: string | null,
>       email: {
>         domain: string | null,
>         provider: string | null
>       },
>       linkedin_url: string | null,
>       linkedin_id: number | null,
>       social_networks: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry: string | null,
>       keywords: string[],
>       naics_codes: number[],
>       ai_industries: string[],
>       type: string | null,
>       business_type: string | null,
>       revenue_stream: string | null,
>       founded: number | null,
>       employee_count: number | null,
>       employee_range: string | null,
>       location: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations: (
>         {
>           city: string | null,
>           state: string | null,
>           state_code: string | null,
>           country: string | null,
>           country_code: string | null,
>           raw_address: string | null
>         } | null
>       )[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null,
>       saved: {
>         id: string | null,
>         saved_at: string | null,
>         list_ids: string[],
>         lists?: {
>           id: string,
>           name: string | null,
>           created_at: string | null
>         }[],
>         edits?: {
>           name?: string
>         }
>       } | null
>     }
>   }[],
>   not_matched: {
>     identifier: string,
>     attempted: (id | linkedin_id | linkedin_url | domain | name | name_search)[]
>   }[],
>   invalid: {
>     identifier: string,
>     reason: string,
>     skipped?: {
>       field: id | linkedin_id | linkedin_url | domain | name | name_search,
>       reason: string
>     }[],
>     unknown_fields?: string[]
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   matched_count: number,
>   not_matched_count: number,
>   invalid_count: number
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### editsUpdate

`companies.editsUpdate`

Edit Saved Company. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.companies.editsUpdate({
	path: { id: '64f1a2b3c4d5e6f7a8b9c0d1' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   edits: {
>     name?: string
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### enrich

`companies.enrich`

Companies Enrich. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.companies.enrich({
	body: {
		data: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     id?: string,
>     linkedin_id?: string | number,
>     linkedin_url?: string,
>     domain?: string,
>     name?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object \| null` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string | null,
>   description: string | null,
>   logo: string | null,
>   website: string | null,
>   email: {
>     domain: string | null,
>     provider: string | null
>   },
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   social_networks: {
>     linkedin_url: string | null,
>     facebook_url: string | null,
>     twitter_url: string | null,
>     instagram_url: string | null,
>     youtube_url: string | null,
>     tiktok_url: string | null,
>     crunchbase_url: string | null,
>     github_url: string | null,
>     pinterest_url: string | null
>   },
>   industry: string | null,
>   keywords: string[],
>   naics_codes: number[],
>   ai_industries: string[],
>   type: string | null,
>   business_type: string | null,
>   revenue_stream: string | null,
>   founded: number | null,
>   employee_count: number | null,
>   employee_range: string | null,
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     raw_address: string | null
>   } | null,
>   other_locations: (
>     {
>       city: string | null,
>       state: string | null,
>       state_code: string | null,
>       country: string | null,
>       country_code: string | null,
>       raw_address: string | null
>     } | null
>   )[],
>   technologies?: {
>     id: string,
>     name: string,
>     icon_url: string | null,
>     website: string | null,
>     categories: {
>       id: string,
>       name: string
>     }[]
>   }[],
>   technologies_checked_at?: string | null,
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     list_ids: string[],
>     lists?: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       name?: string
>     }
>   } | null
> } | null
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   matched_by?: id | linkedin_id | linkedin_url | domain | name | name_search
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### get

`companies.get`

Companies Get. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.companies.get({
	path: { id: '64f1a2b3c4d5e6f7a8b9c0d1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string | null,
>   description: string | null,
>   logo: string | null,
>   website: string | null,
>   email: {
>     domain: string | null,
>     provider: string | null
>   },
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   social_networks: {
>     linkedin_url: string | null,
>     facebook_url: string | null,
>     twitter_url: string | null,
>     instagram_url: string | null,
>     youtube_url: string | null,
>     tiktok_url: string | null,
>     crunchbase_url: string | null,
>     github_url: string | null,
>     pinterest_url: string | null
>   },
>   industry: string | null,
>   keywords: string[],
>   naics_codes: number[],
>   ai_industries: string[],
>   type: string | null,
>   business_type: string | null,
>   revenue_stream: string | null,
>   founded: number | null,
>   employee_count: number | null,
>   employee_range: string | null,
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     raw_address: string | null
>   } | null,
>   other_locations: (
>     {
>       city: string | null,
>       state: string | null,
>       state_code: string | null,
>       country: string | null,
>       country_code: string | null,
>       raw_address: string | null
>     } | null
>   )[],
>   technologies?: {
>     id: string,
>     name: string,
>     icon_url: string | null,
>     website: string | null,
>     categories: {
>       id: string,
>       name: string
>     }[]
>   }[],
>   technologies_checked_at?: string | null,
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     list_ids: string[],
>     lists?: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       name?: string
>     }
>   } | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### save

`companies.save`

Companies Save. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.companies.save({
	body: {
		data: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: (string | {
>     identifier?: string,
>     id?: string,
>     linkedin_id?: string | number,
>     linkedin_url?: string,
>     domain?: string
>   })[],
>   list_ids?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   saved: {
>     identifier: string,
>     id: string,
>     matched_by: id | linkedin_id | linkedin_url | domain | name | name_search,
>     list_ids: string[],
>     saved_at: string | null,
>     all_list_ids: string[]
>   }[],
>   not_matched: {
>     identifier: string,
>     attempted: string[]
>   }[],
>   invalid: {
>     identifier: string,
>     reason: string,
>     skipped?: string[],
>     unknown_fields?: string[]
>   }[],
>   failed: {
>     identifier: string,
>     id: string,
>     reason: string
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   saved_count: number,
>   not_matched_count: number,
>   invalid_count: number,
>   failed_count: number,
>   credits?: {
>     wallet_usd?: number
>   } | null
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### search

`companies.search`

Companies Search. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.companies.search({
	body: {
		filters: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters: {
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     lists?: {
>       saved?: any | none | without_list,
>       include?: string[],
>       exclude?: string[]
>     }
>   },
>   sort_by?: company_name | company_employee_count | company_industry | company_country | company_founded | company_saved_at,
>   sort_direction?: asc | desc,
>   page?: number,
>   per_page?: 25 | 50 | 100
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string | null,
>   description: string | null,
>   logo: string | null,
>   website: string | null,
>   email: {
>     domain: string | null,
>     provider: string | null
>   },
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   social_networks: {
>     linkedin_url: string | null,
>     facebook_url: string | null,
>     twitter_url: string | null,
>     instagram_url: string | null,
>     youtube_url: string | null,
>     tiktok_url: string | null,
>     crunchbase_url: string | null,
>     github_url: string | null,
>     pinterest_url: string | null
>   },
>   industry: string | null,
>   keywords: string[],
>   naics_codes: number[],
>   ai_industries: string[],
>   type: string | null,
>   business_type: string | null,
>   revenue_stream: string | null,
>   founded: number | null,
>   employee_count: number | null,
>   employee_range: string | null,
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     raw_address: string | null
>   } | null,
>   other_locations: (
>     {
>       city: string | null,
>       state: string | null,
>       state_code: string | null,
>       country: string | null,
>       country_code: string | null,
>       raw_address: string | null
>     } | null
>   )[],
>   technologies?: {
>     id: string,
>     name: string,
>     icon_url: string | null,
>     website: string | null,
>     categories: {
>       id: string,
>       name: string
>     }[]
>   }[],
>   technologies_checked_at?: string | null,
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     list_ids: string[],
>     lists?: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       name?: string
>     }
>   } | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   sort_by: company_name | company_employee_count | company_industry | company_country | company_founded | company_saved_at | relevance | followers,
>   sort_direction: asc | desc,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   },
>   lists_filter?: {
>     truncated: boolean,
>     companies_used: number
>   },
>   company_lists?: {
>     truncated?: boolean
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Developer

### apiLogsList

`developer.apiLogsList`

List Request Logs. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.developer.apiLogsList({
	query: { per_page: 1, before: 'x', key_id: '64f1a2b3c4d5e6f7a8b9c0d1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   per_page?: number,
>   before?: string,
>   key_id?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   time: string | null,
>   key_id: string | null,
>   key_name: string,
>   method: string,
>   path: string,
>   status_code: number,
>   duration_ms: number,
>   request_body: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     per_page: number,
>     has_more: boolean,
>     next_cursor: string | null
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### rateLimitsGet

`developer.rateLimitsGet`

Get Rate Limits. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.developer.rateLimitsGet({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   tier: free | freeWallet | tier49 | tier99 | tier199 | tier399,
>   plan_name: string | null,
>   enforced_channels: (app | extension | sheets | api | system | mcp)[],
>   enforced: boolean,
>   buckets: {
>     search: {
>       limits: {
>         second: number,
>         minute: number,
>         day: number
>       },
>       used: {
>         minute: number,
>         day: number
>       },
>       reset: {
>         minute: number,
>         day: number
>       }
>     },
>     enrich: {
>       limits: {
>         second: number,
>         minute: number,
>         day: number
>       },
>       used: {
>         minute: number,
>         day: number
>       },
>       reset: {
>         minute: number,
>         day: number
>       }
>     },
>     jobs: {
>       limits: {
>         second: number,
>         minute: number,
>         day: number
>       },
>       used: {
>         minute: number,
>         day: number
>       },
>       reset: {
>         minute: number,
>         day: number
>       }
>     },
>     poll: {
>       limits: {
>         second: number,
>         minute: number,
>         day: number
>       },
>       used: {
>         minute: number,
>         day: number
>       },
>       reset: {
>         minute: number,
>         day: number
>       }
>     },
>     email: {
>       limits: {
>         second: number,
>         minute: number,
>         day: number
>       },
>       used: {
>         minute: number,
>         day: number
>       },
>       reset: {
>         minute: number,
>         day: number
>       }
>     }
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Email

### find

`email.find`

Find Email. Credit cost: served\_address (a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free)).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.find({
	body: {
		data: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: served\_address; a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free). Check the workspace balance and the provider response before repeating the request. This synchronous endpoint can take up to 95 seconds; the client uses the documented timeout.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     full_name?: string,
>     first_name?: string,
>     last_name?: string,
>     domain?: string,
>     company?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: string | null,
>   status: valid | not_found,
>   account: string | null,
>   domain: string | null,
>   domain_status: valid | invalid | accept_all | disposable | unknown | null,
>   smtp_provider: string | null,
>   free_email: boolean | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   credits?: {
>     email_search?: number,
>     email_verification?: number,
>     reset_at?: string | null,
>     wallet_usd?: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### findGet

`email.findGet`

Find Email (GET). Credit cost: served\_address (a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free)).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.findGet({
	query: {
		full_name: 'x',
		first_name: 'x',
		last_name: 'x',
		domain: 'x',
		company: 'x',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

Credit-aware operation: served\_address; a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free). Check the workspace balance and the provider response before repeating the request.

> [accordion] query full type
>
> ```ts theme={null}
> {
>   full_name?: string,
>   first_name?: string,
>   last_name?: string,
>   domain?: string,
>   company?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: string | null,
>   status: valid | not_found,
>   account: string | null,
>   domain: string | null,
>   domain_status: valid | invalid | accept_all | disposable | unknown | null,
>   smtp_provider: string | null,
>   free_email: boolean | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   credits?: {
>     email_search?: number,
>     email_verification?: number,
>     reset_at?: string | null,
>     wallet_usd?: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsCancel

`email.verificationsCancel`

Cancel Email Verification. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.email.verificationsCancel({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   source: api | file | paste | null,
>   status: queued | counting | awaiting_confirmation | verifying | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   auto_start_blocked: {
>     at: string,
>     reason: credits
>   } | null,
>   counts: {
>     total_rows: number,
>     parsed_rows: number,
>     billable: number,
>     duplicates: number,
>     invalid_syntax: number,
>     blank: number,
>     verified: number,
>     valid: number,
>     invalid: number,
>     accept_all: number,
>     unknown: number
>   },
>   batches: {
>     total: number,
>     done: number
>   },
>   progress_percent: number,
>   result_files: {
>     all: {
>       url: string
>     } | null,
>     valid: {
>       url: string
>     } | null,
>     invalid: {
>       url: string
>     } | null
>   } | null,
>   result_expires_at: string | null,
>   results_expires_at: string | null,
>   results_available: boolean,
>   results_unavailable_reason: too_large | not_stored | expired | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null
>   },
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   created_by: {
>     id: string,
>     name: string | null
>   } | null,
>   error: string | null,
>   created_at: string | null,
>   updated_at: string | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsCreate

`email.verificationsCreate`

Create Email Verification. Credit cost: billable\_row (when a `data.emails` job starts on its own after counting, for `counts.billable`; `unknown` rows and rows never verified are refunded when the job ends (a `file_key` job charges at `email_verifications_start`)).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.email.verificationsCreate({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {
		data: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: billable\_row; when a `data.emails` job starts on its own after counting, for `counts.billable`; `unknown` rows and rows never verified are refunded when the job ends (a `file_key` job charges at `email_verifications_start`). Check the workspace balance and the provider response before repeating the request.

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     emails?: string[],
>     file_key?: string,
>     name?: string,
>     email_column?: number,
>     source?: file | paste
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   source: api | file | paste | null,
>   status: queued | counting | awaiting_confirmation | verifying | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   auto_start_blocked: {
>     at: string,
>     reason: credits
>   } | null,
>   counts: {
>     total_rows: number,
>     parsed_rows: number,
>     billable: number,
>     duplicates: number,
>     invalid_syntax: number,
>     blank: number,
>     verified: number,
>     valid: number,
>     invalid: number,
>     accept_all: number,
>     unknown: number
>   },
>   batches: {
>     total: number,
>     done: number
>   },
>   progress_percent: number,
>   result_files: {
>     all: {
>       url: string
>     } | null,
>     valid: {
>       url: string
>     } | null,
>     invalid: {
>       url: string
>     } | null
>   } | null,
>   result_expires_at: string | null,
>   results_expires_at: string | null,
>   results_available: boolean,
>   results_unavailable_reason: too_large | not_stored | expired | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null
>   },
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   created_by: {
>     id: string,
>     name: string | null
>   } | null,
>   error: string | null,
>   created_at: string | null,
>   updated_at: string | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsGet

`email.verificationsGet`

Get Email Verification. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verificationsGet({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   source: api | file | paste | null,
>   status: queued | counting | awaiting_confirmation | verifying | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   auto_start_blocked: {
>     at: string,
>     reason: credits
>   } | null,
>   counts: {
>     total_rows: number,
>     parsed_rows: number,
>     billable: number,
>     duplicates: number,
>     invalid_syntax: number,
>     blank: number,
>     verified: number,
>     valid: number,
>     invalid: number,
>     accept_all: number,
>     unknown: number
>   },
>   batches: {
>     total: number,
>     done: number
>   },
>   progress_percent: number,
>   result_files: {
>     all: {
>       url: string
>     } | null,
>     valid: {
>       url: string
>     } | null,
>     invalid: {
>       url: string
>     } | null
>   } | null,
>   result_expires_at: string | null,
>   results_expires_at: string | null,
>   results_available: boolean,
>   results_unavailable_reason: too_large | not_stored | expired | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null
>   },
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   created_by: {
>     id: string,
>     name: string | null
>   } | null,
>   error: string | null,
>   created_at: string | null,
>   updated_at: string | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsHistoryList

`email.verificationsHistoryList`

List Verification History. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verificationsHistoryList({
	query: { page: 1, per_page: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   per_page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   email: string,
>   status: valid | invalid | accept_all | unknown,
>   provider: string,
>   domain: string,
>   free_email: boolean | null,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   verified_by: {
>     id: string,
>     name: string | null
>   } | null,
>   created_at: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean,
>     page_size: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsInspect

`email.verificationsInspect`

Inspect Email File. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verificationsInspect({
	body: {
		data: { file_key: 'x' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     file_key: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   headers: string[],
>   preview: string[][],
>   delimiter: string | null,
>   encoding: string,
>   has_header: boolean,
>   email_column_candidates: {
>     index: number,
>     header: string | null,
>     sample: string
>   }[],
>   suggested_email_column: number | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsList

`email.verificationsList`

List Email Verifications. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verificationsList({
	query: {
		page: 1,
		per_page: 1,
		query: 'x',
		owner: 'x',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   per_page?: number,
>   query?: string,
>   owner?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   source: api | file | paste | null,
>   status: queued | counting | awaiting_confirmation | verifying | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   auto_start_blocked: {
>     at: string,
>     reason: credits
>   } | null,
>   counts: {
>     total_rows: number,
>     parsed_rows: number,
>     billable: number,
>     duplicates: number,
>     invalid_syntax: number,
>     blank: number,
>     verified: number,
>     valid: number,
>     invalid: number,
>     accept_all: number,
>     unknown: number
>   },
>   batches: {
>     total: number,
>     done: number
>   },
>   progress_percent: number,
>   result_files: {
>     all: {
>       url: string
>     } | null,
>     valid: {
>       url: string
>     } | null,
>     invalid: {
>       url: string
>     } | null
>   } | null,
>   result_expires_at: string | null,
>   results_expires_at: string | null,
>   results_available: boolean,
>   results_unavailable_reason: too_large | not_stored | expired | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null
>   },
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   created_by: {
>     id: string,
>     name: string | null
>   } | null,
>   error: string | null,
>   created_at: string | null,
>   updated_at: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean,
>     page_size: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsResults

`email.verificationsResults`

Get Email Verification Results. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verificationsResults({
	path: { id: 'x' },
	query: {
		cursor: 'x',
		limit: 1,
		status: 'valid',
		q: 'x',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   cursor?: string,
>   limit?: number,
>   status?: valid | invalid | accept_all | unknown,
>   q?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: string,
>   status: valid | invalid | accept_all | unknown,
>   account: string,
>   domain: string,
>   domain_status: string,
>   smtp_provider: string,
>   provider: string,
>   free_email: boolean | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     next_cursor: string | null,
>     limit: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verificationsStart

`email.verificationsStart`

Start Email Verification. Credit cost: billable\_row (at start, for `counts.billable`; `unknown` rows and rows never verified are refunded when the job ends).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.email.verificationsStart({
	path: { id: 'x' },
	headers: { idempotencyKey: 'stable-test-key' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `undefined` | No | — |

Credit-aware operation: billable\_row; at start, for `counts.billable`; `unknown` rows and rows never verified are refunded when the job ends. Check the workspace balance and the provider response before repeating the request.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   source: api | file | paste | null,
>   status: queued | counting | awaiting_confirmation | verifying | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   auto_start_blocked: {
>     at: string,
>     reason: credits
>   } | null,
>   counts: {
>     total_rows: number,
>     parsed_rows: number,
>     billable: number,
>     duplicates: number,
>     invalid_syntax: number,
>     blank: number,
>     verified: number,
>     valid: number,
>     invalid: number,
>     accept_all: number,
>     unknown: number
>   },
>   batches: {
>     total: number,
>     done: number
>   },
>   progress_percent: number,
>   result_files: {
>     all: {
>       url: string
>     } | null,
>     valid: {
>       url: string
>     } | null,
>     invalid: {
>       url: string
>     } | null
>   } | null,
>   result_expires_at: string | null,
>   results_expires_at: string | null,
>   results_available: boolean,
>   results_unavailable_reason: too_large | not_stored | expired | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null
>   },
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null,
>   created_by: {
>     id: string,
>     name: string | null
>   } | null,
>   error: string | null,
>   created_at: string | null,
>   updated_at: string | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verify

`email.verify`

Verify Email. Credit cost: address (a valid, invalid or accept\_all verdict, once per address per workspace).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verify({
	body: {
		data: { email: 'person@samplemail.test' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: address; a valid, invalid or accept\_all verdict, once per address per workspace. Check the workspace balance and the provider response before repeating the request. The provider documents a lookup timeout of up to 80 seconds; wallet charges apply only to billable verdicts.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     email: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: string,
>   status: valid | invalid | accept_all | unknown,
>   account: string,
>   domain: string,
>   domain_status: string,
>   smtp_provider: string,
>   free_email: boolean | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   credits?: {
>     email_search?: number,
>     email_verification?: number,
>     reset_at?: string | null,
>     wallet_usd?: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### verifyGet

`email.verifyGet`

Verify Email (GET). Credit cost: address (a valid, invalid or accept\_all verdict, once per address per workspace).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.email.verifyGet({
	query: { email: 'person@samplemail.test' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | Yes | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

Credit-aware operation: address; a valid, invalid or accept\_all verdict, once per address per workspace. Check the workspace balance and the provider response before repeating the request.

> [accordion] query full type
>
> ```ts theme={null}
> {
>   email: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: string,
>   status: valid | invalid | accept_all | unknown,
>   account: string,
>   domain: string,
>   domain_status: string,
>   smtp_provider: string,
>   free_email: boolean | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   credits?: {
>     email_search?: number,
>     email_verification?: number,
>     reset_at?: string | null,
>     wallet_usd?: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Enrichments

### cancel

`enrichments.cancel`

Cancel Enrichment. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.enrichments.cancel({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people | companies,
>   name: string,
>   source: api | file,
>   status: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   options: {
>     enrich_email: boolean,
>     enrich_phone: boolean
>   } | null,
>   progress: {
>     percent: number,
>     done: number | null,
>     total: number | null
>   },
>   counts: {
>     rows: number,
>     matched: number,
>     not_matched: number,
>     invalid: number,
>     emails_found: number,
>     phones_found: number
>   },
>   credits_used: {
>     email: number,
>     phone: number
>   },
>   created_at: string | null,
>   started_at: string | null,
>   finished_at: string | null,
>   results_expires_at: string | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null,
>     csv: string | null,
>     jsonl: string | null
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### companiesEnrichmentsCreate

`enrichments.companiesEnrichmentsCreate`

Create Companies Enrichment. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.enrichments.companiesEnrichmentsCreate({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {
		data: [{}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   data: {
>     identifier?: string,
>     linkedin_url?: string,
>     domain?: string,
>     name?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people | companies,
>   name: string,
>   source: api | file,
>   status: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   options: {
>     enrich_email: boolean,
>     enrich_phone: boolean
>   } | null,
>   progress: {
>     percent: number,
>     done: number | null,
>     total: number | null
>   },
>   counts: {
>     rows: number,
>     matched: number,
>     not_matched: number,
>     invalid: number,
>     emails_found: number,
>     phones_found: number
>   },
>   credits_used: {
>     email: number,
>     phone: number
>   },
>   created_at: string | null,
>   started_at: string | null,
>   finished_at: string | null,
>   results_expires_at: string | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null,
>     csv: string | null,
>     jsonl: string | null
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### get

`enrichments.get`

Get Enrichment. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.enrichments.get({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people | companies,
>   name: string,
>   source: api | file,
>   status: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   options: {
>     enrich_email: boolean,
>     enrich_phone: boolean
>   } | null,
>   progress: {
>     percent: number,
>     done: number | null,
>     total: number | null
>   },
>   counts: {
>     rows: number,
>     matched: number,
>     not_matched: number,
>     invalid: number,
>     emails_found: number,
>     phones_found: number
>   },
>   credits_used: {
>     email: number,
>     phone: number
>   },
>   created_at: string | null,
>   started_at: string | null,
>   finished_at: string | null,
>   results_expires_at: string | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null,
>     csv: string | null,
>     jsonl: string | null
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### list

`enrichments.list`

List Enrichments. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.enrichments.list({
	query: {
		page: 1,
		per_page: 1,
		status: 'queued',
		source: 'api',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   per_page?: number,
>   status?: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   source?: api | file
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people | companies,
>   name: string,
>   source: api | file,
>   status: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   options: {
>     enrich_email: boolean,
>     enrich_phone: boolean
>   } | null,
>   progress: {
>     percent: number,
>     done: number | null,
>     total: number | null
>   },
>   counts: {
>     rows: number,
>     matched: number,
>     not_matched: number,
>     invalid: number,
>     emails_found: number,
>     phones_found: number
>   },
>   credits_used: {
>     email: number,
>     phone: number
>   },
>   created_at: string | null,
>   started_at: string | null,
>   finished_at: string | null,
>   results_expires_at: string | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null,
>     csv: string | null,
>     jsonl: string | null
>   }
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleEnrichmentsCreate

`enrichments.peopleEnrichmentsCreate`

Create People Enrichment. Credit cost: revealed profile not already owned / address found / mobile number found (during the job).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.enrichments.peopleEnrichmentsCreate({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {
		data: [{}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: revealed profile not already owned / address found / mobile number found; during the job. Check the workspace balance and the provider response before repeating the request.

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   data: {
>     identifier?: string,
>     linkedin_url?: string,
>     email?: string,
>     first_name?: string,
>     last_name?: string,
>     company_domain?: string,
>     company_name?: string
>   }[],
>   enrich_email?: boolean,
>   enrich_phone?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people | companies,
>   name: string,
>   source: api | file,
>   status: queued | sampling | matching | awaiting_confirmation | enriching | finding | assembling | completed | failed | cancelled,
>   stopped_reason: string | null,
>   options: {
>     enrich_email: boolean,
>     enrich_phone: boolean
>   } | null,
>   progress: {
>     percent: number,
>     done: number | null,
>     total: number | null
>   },
>   counts: {
>     rows: number,
>     matched: number,
>     not_matched: number,
>     invalid: number,
>     emails_found: number,
>     phones_found: number
>   },
>   credits_used: {
>     email: number,
>     phone: number
>   },
>   created_at: string | null,
>   started_at: string | null,
>   finished_at: string | null,
>   results_expires_at: string | null,
>   links: {
>     self: string,
>     job: string,
>     results: string | null,
>     csv: string | null,
>     jsonl: string | null
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### results

`enrichments.results`

Get Enrichment Results. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.enrichments.results({
	path: { id: 'x' },
	query: { cursor: 'x', limit: 1, status: 'matched' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   cursor?: string,
>   limit?: number,
>   status?: matched | not_matched | invalid | failed | not_processed
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   identifier: string,
>   status: matched | not_matched | invalid | failed | not_processed,
>   matched_by?: string | null,
>   input: Record<string, string>,
>   person?: {
>     id: string,
>     full_name: string | null,
>     first_name: string | null,
>     last_name: string | null,
>     email: {
>       status: valid | not_found | not_checked | searching | null,
>       address: string | null,
>       domain: string | null,
>       domain_status: valid | invalid | accept_all | disposable | unknown | null,
>       provider: string | null,
>       verified_at: string | null,
>       checked_at: string | null,
>       revealed: boolean,
>       retry_after?: number
>     },
>     mobile_phone: {
>       status: not_requested | found | not_found | error | null,
>       number: string | null,
>       numbers: string[],
>       revealed: boolean,
>       checked_at: string | null
>     },
>     location: {
>       city: string | null,
>       state: string | null,
>       state_code: string | null,
>       country: string | null,
>       country_code: string | null,
>       time_zone: string | null,
>       time_zone_offset: number | null
>     } | null,
>     linkedin_url: string | null,
>     linkedin_id: number | null,
>     followers: number | null,
>     primary_position: {
>       job_title: string | null,
>       normalized_job_title: string | null,
>       seniority: string | null,
>       departments: string[],
>       start_date: string | null,
>       company: {
>         id?: string | null,
>         name?: string | null,
>         description?: string | null,
>         logo?: string | null,
>         website?: string | null,
>         email?: {
>           status: valid | not_found | not_checked | searching | null,
>           address: string | null,
>           domain: string | null,
>           domain_status: valid | invalid | accept_all | disposable | unknown | null,
>           provider: string | null,
>           verified_at: string | null,
>           checked_at: string | null,
>           revealed: boolean,
>           retry_after?: number
>         },
>         linkedin_url?: string | null,
>         social_networks?: {
>           linkedin_url: string | null,
>           facebook_url: string | null,
>           twitter_url: string | null,
>           instagram_url: string | null,
>           youtube_url: string | null,
>           tiktok_url: string | null,
>           crunchbase_url: string | null,
>           github_url: string | null,
>           pinterest_url: string | null
>         },
>         industry?: string | null,
>         keywords?: string[],
>         naics_codes?: number[],
>         ai_industries?: string[],
>         type?: string | null,
>         business_type?: string | null,
>         revenue_stream?: string | null,
>         founded?: number | null,
>         employee_count?: number | null,
>         employee_range?: string | null,
>         location?: {
>           city: string | null,
>           state: string | null,
>           state_code: string | null,
>           country: string | null,
>           country_code: string | null,
>           raw_address: string | null
>         } | null,
>         other_locations?: {
>           city: string | null,
>           state: string | null,
>           state_code: string | null,
>           country: string | null,
>           country_code: string | null,
>           raw_address: string | null
>         }[],
>         technologies?: {
>           id: string,
>           name: string,
>           icon_url: string | null,
>           website: string | null,
>           categories: {
>             id: string,
>             name: string
>           }[]
>         }[],
>         technologies_checked_at?: string | null
>       } | null,
>       position_index: number,
>       id: string | null
>     } | null,
>     other_positions?: {
>       job_title: string | null,
>       normalized_job_title: string | null,
>       seniority: string | null,
>       departments: string[],
>       start_date: string | null,
>       company: {
>         id?: string | null,
>         name?: string | null,
>         description?: string | null,
>         logo?: string | null,
>         website?: string | null,
>         email?: {
>           status: valid | not_found | not_checked | searching | null,
>           address: string | null,
>           domain: string | null,
>           domain_status: valid | invalid | accept_all | disposable | unknown | null,
>           provider: string | null,
>           verified_at: string | null,
>           checked_at: string | null,
>           revealed: boolean,
>           retry_after?: number
>         },
>         linkedin_url?: string | null,
>         social_networks?: {
>           linkedin_url: string | null,
>           facebook_url: string | null,
>           twitter_url: string | null,
>           instagram_url: string | null,
>           youtube_url: string | null,
>           tiktok_url: string | null,
>           crunchbase_url: string | null,
>           github_url: string | null,
>           pinterest_url: string | null
>         },
>         industry?: string | null,
>         keywords?: string[],
>         naics_codes?: number[],
>         ai_industries?: string[],
>         type?: string | null,
>         business_type?: string | null,
>         revenue_stream?: string | null,
>         founded?: number | null,
>         employee_count?: number | null,
>         employee_range?: string | null,
>         location?: {
>           city: string | null,
>           state: string | null,
>           state_code: string | null,
>           country: string | null,
>           country_code: string | null,
>           raw_address: string | null
>         } | null,
>         other_locations?: {
>           city: string | null,
>           state: string | null,
>           state_code: string | null,
>           country: string | null,
>           country_code: string | null,
>           raw_address: string | null
>         }[],
>         technologies?: {
>           id: string,
>           name: string,
>           icon_url: string | null,
>           website: string | null,
>           categories: {
>             id: string,
>             name: string
>           }[]
>         }[],
>         technologies_checked_at?: string | null
>       } | null,
>       position_index: number,
>       id: string | null
>     }[],
>     saved: {
>       id: string | null,
>       saved_at: string | null,
>       lists: {
>         id: string,
>         name: string | null,
>         created_at: string | null
>       }[],
>       edits?: {
>         first_name?: string,
>         last_name?: string,
>         email?: string,
>         phone?: string
>       }
>     } | null,
>     matched_url?: string | null
>   } | {
>     id: string | null,
>     full_name: string | null,
>     first_name: string | null,
>     last_name: string | null,
>     linkedin_url: string | null,
>     email: {
>       status: valid | not_found | not_checked | searching | null,
>       address: string | null,
>       domain: string | null,
>       domain_status: valid | invalid | accept_all | disposable | unknown | null,
>       provider: string | null,
>       verified_at: string | null,
>       checked_at: string | null,
>       revealed: boolean,
>       retry_after?: number
>     },
>     primary_position: {
>       company: {
>         name: string | null,
>         domain: string | null
>       }
>     }
>   } | null,
>   company?: {
>     id: string,
>     name: string | null,
>     description: string | null,
>     logo: string | null,
>     website: string | null,
>     email: {
>       domain: string | null,
>       provider: string | null
>     },
>     linkedin_url: string | null,
>     linkedin_id: number | null,
>     social_networks: {
>       linkedin_url: string | null,
>       facebook_url: string | null,
>       twitter_url: string | null,
>       instagram_url: string | null,
>       youtube_url: string | null,
>       tiktok_url: string | null,
>       crunchbase_url: string | null,
>       github_url: string | null,
>       pinterest_url: string | null
>     },
>     industry: string | null,
>     keywords: string[],
>     naics_codes: number[],
>     ai_industries: string[],
>     type: string | null,
>     business_type: string | null,
>     revenue_stream: string | null,
>     founded: number | null,
>     employee_count: number | null,
>     employee_range: string | null,
>     location: {
>       city: string | null,
>       state: string | null,
>       state_code: string | null,
>       country: string | null,
>       country_code: string | null,
>       raw_address: string | null
>     } | null,
>     other_locations: (
>       {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null
>     )[],
>     technologies?: {
>       id: string,
>       name: string,
>       icon_url: string | null,
>       website: string | null,
>       categories: {
>         id: string,
>         name: string
>       }[]
>     }[],
>     technologies_checked_at?: string | null,
>     saved: {
>       id: string | null,
>       saved_at: string | null,
>       list_ids: string[],
>       lists?: {
>         id: string,
>         name: string | null,
>         created_at: string | null
>       }[],
>       edits?: {
>         name?: string
>       }
>     } | null
>   } | null,
>   error?: {
>     code: string,
>     message: string
>   }
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     next_cursor: string | null,
>     limit: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Enums

### get

`enums.get`

Get Filter Enum. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.enums.get({
	path: { name: 'industries' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   name: industries | countries | employee_ranges | company_types | business_types | revenue_streams | keywords_sources | departments | seniorities | regions | ai_industries
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `JsonValue` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### list

`enums.list`

List Filter Enums. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.enums.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   industries: Record<string, string[]>,
>   countries: string[],
>   employee_ranges: string[],
>   company_types: string[],
>   business_types: string[],
>   revenue_streams: string[],
>   keywords_sources: string[],
>   departments: Record<string, string[]>,
>   seniorities: string[],
>   regions: Record<string, string[]>,
>   ai_industries: Record<string, string[]>
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Exports

### companiesExport

`exports.companiesExport`

Export Companies. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.exports.companiesExport({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     lists?: {
>       saved?: any | none | without_list,
>       include?: string[],
>       exclude?: string[]
>     }
>   },
>   sort_by?: company_name | company_employee_count | company_industry | company_country | company_founded | company_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[],
>   columns?: (name | domain | website | linkedin_url | industry | employee_count | employee_range | type | business_type | revenue_stream | founded | keywords | naics_codes | country | state | city | raw_address | description | logo_url | email_domain | email_provider | id | saved_at | in_lists | ai_industries)[],
>   file_format?: csv | xlsx,
>   name?: string,
>   source?: {
>     type: search | list,
>     list_id?: string,
>     search_id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   status: in_progress | done | failed,
>   requested: number
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### get

`exports.get`

Get an Export. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.exports.get({
	path: { id: '64f1a2b3c4d5e6f7a8b9c0d1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   status: in_progress | done | failed,
>   record_type: people | companies,
>   source: {
>     type: search | list,
>     list_id: string | null,
>     list_name: string | null,
>     search_id: string | null
>   } | null,
>   scope: all | with_email,
>   file_format: csv | xlsx,
>   counts: {
>     requested: number,
>     exported: number,
>     with_email: number,
>     withheld_emails: number
>   },
>   total: number,
>   credits: {
>     emails_charged: number,
>     total: number
>   },
>   data_file_url: string | null,
>   stopped_reason: string | null,
>   created_at: string | null,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     email: string | null,
>     profile_photo: string | null
>   } | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleExport

`exports.peopleExport`

Export People. Credit cost: revealed profile not already owned (per chunk during the run, against the balance read at that chunk; emails past it are withheld).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.exports.peopleExport({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: revealed profile not already owned; per chunk during the run, against the balance read at that chunk; emails past it are withheld. Check the workspace balance and the provider response before repeating the request.

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[],
>   pins?: {
>     person_id: string,
>     position_id?: string,
>     position_index?: number
>   }[],
>   scope?: all | with_email,
>   columns?: (first_name | last_name | name | linkedin_url | email | email_domain_status | mobile_phone | job_title | normalized_job_title | departments | seniority | person_country | person_country_code | person_state | person_city | person_time_zone | person_time_zone_offset | person_id | in_lists | saved_at | company_name | company_industry | company_domain | employee_range | employee_count | company_linkedin_url | company_type | company_country | company_country_code | company_state | company_city | company_raw_address | company_keywords | company_description | company_founded | company_logo_url | company_email_domain | company_email_provider | company_id | company_in_lists | company_saved_at | company_ai_industries | other_positions)[],
>   file_format?: csv | xlsx,
>   name?: string,
>   source?: {
>     type: search | list,
>     list_id?: string,
>     search_id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   status: in_progress | done | failed,
>   requested: number
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Jobs

### get

`jobs.get`

Get a Job. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.jobs.get({
	path: { id: '64f1a2b3c4d5e6f7a8b9c0d1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people_export,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null
> } | {
>   id: string,
>   type: companies_export,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null
> } | {
>   id: string,
>   type: csv_enrichment,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null
> } | {
>   id: string,
>   type: email_verification,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null
> } | {
>   id: string,
>   type: people_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     deleted: number,
>     skipped: number
>   }
> } | {
>   id: string,
>   type: companies_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     deleted: number,
>     skipped: number
>   }
> } | {
>   id: string,
>   type: people_lists_set,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     updated: number,
>     skipped: number
>   }
> } | {
>   id: string,
>   type: companies_lists_set,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     updated: number,
>     skipped: number
>   }
> } | {
>   id: string,
>   type: list_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     list: boolean,
>     records_deleted: number
>   }
> } | {
>   id: string,
>   type: trash_restore,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     restored: number,
>     lists_restored: number,
>     skipped: number
>   }
> } | {
>   id: string,
>   type: integration_push_all,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     integration: string,
>     records_queued: number
>   } | null
> } | {
>   id: string,
>   type: people_save_search,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     requested: number,
>     saved: number,
>     not_found: number,
>     stopped_reason: string | null,
>     truncated: boolean
>   }
> } | {
>   id: string,
>   type: people_enrich_search,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     requested: number,
>     truncated: boolean,
>     found: number,
>     already_not_found: number,
>     stopped_reason: string | null,
>     capped_by_plan?: number
>   }
> } | {
>   id: string,
>   type: companies_save_search,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     requested: number,
>     saved: number,
>     not_found: number,
>     stopped_reason: string | null,
>     truncated: boolean
>   } | null
> } | {
>   id: string,
>   type: sequences_leads_enroll,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     added: number,
>     already_enrolled: number,
>     opted_out: number,
>     no_email: number,
>     not_found: number
>   }
> } | {
>   id: string,
>   type: sequences_leads_pause,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     matched: number,
>     updated: number,
>     skipped: {
>       person_id: string | null,
>       reason: string
>     }[]
>   }
> } | {
>   id: string,
>   type: sequences_leads_opt_out,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     matched: number,
>     updated: number,
>     skipped: {
>       person_id: string | null,
>       reason: string
>     }[]
>   }
> } | {
>   id: string,
>   type: sequences_leads_resume,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     matched: number,
>     updated: number,
>     skipped: {
>       person_id: string | null,
>       reason: string
>     }[]
>   }
> } | {
>   id: string,
>   type: sequences_leads_remove,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     removed: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Lists

### companiesListsRemove

`lists.companiesListsRemove`

Remove Companies from List. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.lists.companiesListsRemove({
	body: {
		list_id: 'x',
		ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   list_id: string,
>   ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   removed: number
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### companiesListsSet

`lists.companiesListsSet`

Set Company Lists. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.lists.companiesListsSet({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {
		list_ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     lists?: {
>       saved?: any | none | without_list,
>       include?: string[],
>       exclude?: string[]
>     }
>   },
>   sort_by?: company_name | company_employee_count | company_industry | company_country | company_founded | company_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[],
>   list_ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: companies_lists_set,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     updated: number,
>     skipped: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### create

`lists.create`

Create List. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.lists.create({
	body: { name: 'x', type: 'people' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name: string,
>   type: people | companies
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   type: people | companies,
>   records_count: number,
>   last_added_record_at: string | null,
>   created_at: string,
>   updated_at: string,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### delete

`lists.delete`

Delete List. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.lists.delete({
	path: { id: 'x' },
	query: { with_records: 'true' },
	headers: { idempotencyKey: 'stable-test-key' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   with_records?: true | false
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: list_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     list: boolean,
>     records_deleted: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### get

`lists.get`

Get List. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.lists.get({
	path: { id: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   type: people | companies,
>   records_count: number,
>   last_added_record_at: string | null,
>   created_at: string,
>   updated_at: string,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### list

`lists.list`

List Lists. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.lists.list({
	query: {
		type: 'people',
		owner: 'x',
		query: 'x',
		sort_by: 'name',
		sort_direction: 'asc',
		include_saved_views: 'true',
		page: 1,
		per_page: 1,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   type?: people | companies,
>   owner?: string,
>   query?: string,
>   sort_by?: name | records_count | owner | created_at | updated_at,
>   sort_direction?: asc | desc,
>   include_saved_views?: true | false,
>   page?: number,
>   per_page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   type: people | companies,
>   records_count: number,
>   last_added_record_at: string | null,
>   created_at: string,
>   updated_at: string,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   },
>   sort_by: string | null,
>   sort_direction: string | null,
>   saved_views?: {
>     type: people | companies,
>     saved: any | without_list,
>     records_count: number | null,
>     last_saved_at: string | null
>   }[]
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleListsAdd

`lists.peopleListsAdd`

Add People to List. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.lists.peopleListsAdd({
	body: {
		list_id: 'x',
		ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   list_id: string,
>   ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   added: number,
>   items: {
>     id: string,
>     status: added | already_in_list | not_saved | invalid
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleListsRemove

`lists.peopleListsRemove`

Remove People from List. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.lists.peopleListsRemove({
	body: {
		list_id: 'x',
		ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   list_id: string,
>   ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   removed: number
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleListsSet

`lists.peopleListsSet`

Set People Lists. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.lists.peopleListsSet({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {
		list_ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[],
>   list_ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people_lists_set,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     updated: number,
>     skipped: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### update

`lists.update`

Rename List. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.lists.update({
	path: { id: 'x' },
	body: { name: 'x' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   name: string,
>   type: people | companies,
>   records_count: number,
>   last_added_record_at: string | null,
>   created_at: string,
>   updated_at: string,
>   owner: {
>     id: string,
>     first_name: string | null,
>     last_name: string | null,
>     photo_url: string | null
>   } | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Notifications

### list

`notifications.list`

List Notifications. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.notifications.list({
	query: { page: 1, per_page: 1, read: 'true' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   per_page?: number,
>   read?: true | false
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   workspace_id: number,
>   type: string,
>   status: done | success | failed | error | in_progress | processing | stopped | info | null,
>   title: string | null,
>   body: string | null,
>   body_format: text | html,
>   link: {
>     url: string,
>     label: string | null,
>     kind: external | app | file,
>     file_name: string | null
>   } | null,
>   subject_id: string | null,
>   read: boolean,
>   read_at: string | null,
>   created_at: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   },
>   unread_count: number
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### markRead

`notifications.markRead`

Mark Notifications Read. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.notifications.markRead({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   all?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   updated_count: number,
>   unread_count: number
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## People

### bulkEnrich

`people.bulkEnrich`

People Bulk Enrich. Credit cost: newly revealed email; phone number found (enrich\_email (on by default) / enrich\_phone, per item).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.bulkEnrich({
	body: {
		data: [{}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: newly revealed email; phone number found; enrich\_email (on by default) / enrich\_phone, per item. Check the workspace balance and the provider response before repeating the request.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     identifier?: string,
>     id?: string,
>     linkedin_id?: string | number,
>     linkedin_url?: string,
>     email?: string,
>     first_name?: string,
>     last_name?: string,
>     company_domain?: string,
>     company_name?: string
>   }[],
>   enrich_email?: boolean,
>   enrich_phone?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   matched: {
>     identifier: string,
>     matched_by: id | linkedin_id | linkedin_url | email | name_and_company,
>     person: {
>       id: string,
>       full_name: string | null,
>       first_name: string | null,
>       last_name: string | null,
>       email: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       mobile_phone: {
>         status: not_requested | found | not_found | error | null,
>         number: string | null,
>         numbers: string[],
>         revealed: boolean,
>         checked_at: string | null
>       },
>       location: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         time_zone: string | null,
>         time_zone_offset: number | null
>       } | null,
>       linkedin_url: string | null,
>       linkedin_id: number | null,
>       followers: number | null,
>       primary_position: {
>         job_title: string | null,
>         normalized_job_title: string | null,
>         seniority: string | null,
>         departments: string[],
>         start_date: string | null,
>         company: {
>           id?: string | null,
>           name?: string | null,
>           description?: string | null,
>           logo?: string | null,
>           website?: string | null,
>           email?: {
>             status: valid | not_found | not_checked | searching | null,
>             address: string | null,
>             domain: string | null,
>             domain_status: valid | invalid | accept_all | disposable | unknown | null,
>             provider: string | null,
>             verified_at: string | null,
>             checked_at: string | null,
>             revealed: boolean,
>             retry_after?: number
>           },
>           linkedin_url?: string | null,
>           social_networks?: {
>             linkedin_url: string | null,
>             facebook_url: string | null,
>             twitter_url: string | null,
>             instagram_url: string | null,
>             youtube_url: string | null,
>             tiktok_url: string | null,
>             crunchbase_url: string | null,
>             github_url: string | null,
>             pinterest_url: string | null
>           },
>           industry?: string | null,
>           keywords?: string[],
>           naics_codes?: number[],
>           ai_industries?: string[],
>           type?: string | null,
>           business_type?: string | null,
>           revenue_stream?: string | null,
>           founded?: number | null,
>           employee_count?: number | null,
>           employee_range?: string | null,
>           location?: {
>             city: string | null,
>             state: string | null,
>             state_code: string | null,
>             country: string | null,
>             country_code: string | null,
>             raw_address: string | null
>           } | null,
>           other_locations?: {
>             city: string | null,
>             state: string | null,
>             state_code: string | null,
>             country: string | null,
>             country_code: string | null,
>             raw_address: string | null
>           }[],
>           technologies?: {
>             id: string,
>             name: string,
>             icon_url: string | null,
>             website: string | null,
>             categories: {
>               id: string,
>               name: string
>             }[]
>           }[],
>           technologies_checked_at?: string | null
>         } | null,
>         position_index: number,
>         id: string | null
>       } | null,
>       other_positions?: {
>         job_title: string | null,
>         normalized_job_title: string | null,
>         seniority: string | null,
>         departments: string[],
>         start_date: string | null,
>         company: {
>           id?: string | null,
>           name?: string | null,
>           description?: string | null,
>           logo?: string | null,
>           website?: string | null,
>           email?: {
>             status: valid | not_found | not_checked | searching | null,
>             address: string | null,
>             domain: string | null,
>             domain_status: valid | invalid | accept_all | disposable | unknown | null,
>             provider: string | null,
>             verified_at: string | null,
>             checked_at: string | null,
>             revealed: boolean,
>             retry_after?: number
>           },
>           linkedin_url?: string | null,
>           social_networks?: {
>             linkedin_url: string | null,
>             facebook_url: string | null,
>             twitter_url: string | null,
>             instagram_url: string | null,
>             youtube_url: string | null,
>             tiktok_url: string | null,
>             crunchbase_url: string | null,
>             github_url: string | null,
>             pinterest_url: string | null
>           },
>           industry?: string | null,
>           keywords?: string[],
>           naics_codes?: number[],
>           ai_industries?: string[],
>           type?: string | null,
>           business_type?: string | null,
>           revenue_stream?: string | null,
>           founded?: number | null,
>           employee_count?: number | null,
>           employee_range?: string | null,
>           location?: {
>             city: string | null,
>             state: string | null,
>             state_code: string | null,
>             country: string | null,
>             country_code: string | null,
>             raw_address: string | null
>           } | null,
>           other_locations?: {
>             city: string | null,
>             state: string | null,
>             state_code: string | null,
>             country: string | null,
>             country_code: string | null,
>             raw_address: string | null
>           }[],
>           technologies?: {
>             id: string,
>             name: string,
>             icon_url: string | null,
>             website: string | null,
>             categories: {
>               id: string,
>               name: string
>             }[]
>           }[],
>           technologies_checked_at?: string | null
>         } | null,
>         position_index: number,
>         id: string | null
>       }[],
>       saved: {
>         id: string | null,
>         saved_at: string | null,
>         lists: {
>           id: string,
>           name: string | null,
>           created_at: string | null
>         }[],
>         edits?: {
>           first_name?: string,
>           last_name?: string,
>           email?: string,
>           phone?: string
>         }
>       } | null,
>       matched_url?: string | null
>     }
>   }[],
>   not_matched: {
>     identifier: string,
>     attempted: (id | linkedin_id | linkedin_url | email | name_and_company)[]
>   }[],
>   invalid: {
>     identifier: string,
>     reason: string,
>     skipped?: {
>       field: id | linkedin_id | linkedin_url | email | name_and_company,
>       reason: string
>     }[],
>     unknown_fields?: string[]
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   matched_count: number,
>   not_matched_count: number,
>   invalid_count: number
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### calculateCredits

`people.calculateCredits`

Preview Save Credits. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.calculateCredits({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters?: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   exclude_ids?: string[],
>   limit?: number,
>   list_ids?: string[],
>   allow_estimate?: boolean,
>   data?: (string | {
>     identifier?: string,
>     id?: string,
>     linkedin_url?: string,
>     primary_position_id?: string,
>     primary_position_index?: number,
>     primary_company_id?: string
>   })[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   requested: number,
>   savable: number,
>   not_matched: number,
>   invalid: number,
>   emails: {
>     to_charge: number,
>     already_owned: number,
>     without_email: number,
>     edited: number
>   },
>   credits_needed: number,
>   credits_available: number,
>   enough_credits: boolean,
>   truncated: boolean,
>   estimate: boolean,
>   sample_size: number | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### count

`people.count`

People Count. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.count({
	body: {
		filters: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   group_by?: (country | department | seniority)[],
>   pivot?: boolean,
>   country_limit?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   total: number,
>   groups?: {
>     country?: {
>       values: {
>         value: string,
>         name?: string,
>         count: number
>       }[],
>       unknown: number
>     },
>     department?: {
>       values: {
>         value: string,
>         name?: string,
>         count: number
>       }[],
>       unknown: number
>     },
>     seniority?: {
>       values: {
>         value: string,
>         name?: string,
>         count: number
>       }[],
>       unknown: number
>     }
>   },
>   pivot?: {
>     country?: string,
>     department?: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales,
>     seniority?: Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid,
>     count: number
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   counted_at: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### editsUpdate

`people.editsUpdate`

Edit a Saved Person. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.people.editsUpdate({
	path: { id: 'x' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   phone?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   edits: {
>     first_name?: string,
>     last_name?: string,
>     email?: string,
>     phone?: string
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### enrich

`people.enrich`

People Enrich. Credit cost: newly revealed email; phone number found (enrich\_email (on by default) / enrich\_phone).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.enrich({
	body: {
		data: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: newly revealed email; phone number found; enrich\_email (on by default) / enrich\_phone. Check the workspace balance and the provider response before repeating the request. This synchronous endpoint can take up to 95 seconds; a searching email result can be polled by calling the endpoint again after retry\_after.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: {
>     id?: string,
>     linkedin_id?: string | number,
>     linkedin_url?: string,
>     email?: string,
>     first_name?: string,
>     last_name?: string,
>     company_domain?: string,
>     company_name?: string
>   },
>   enrich_email?: boolean,
>   enrich_phone?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object \| null` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   full_name: string | null,
>   first_name: string | null,
>   last_name: string | null,
>   email: {
>     status: valid | not_found | not_checked | searching | null,
>     address: string | null,
>     domain: string | null,
>     domain_status: valid | invalid | accept_all | disposable | unknown | null,
>     provider: string | null,
>     verified_at: string | null,
>     checked_at: string | null,
>     revealed: boolean,
>     retry_after?: number
>   },
>   mobile_phone: {
>     status: not_requested | found | not_found | error | null,
>     number: string | null,
>     numbers: string[],
>     revealed: boolean,
>     checked_at: string | null
>   },
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     time_zone: string | null,
>     time_zone_offset: number | null
>   } | null,
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   followers: number | null,
>   primary_position: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   } | null,
>   other_positions?: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   }[],
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     lists: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       first_name?: string,
>       last_name?: string,
>       email?: string,
>       phone?: string
>     }
>   } | null,
>   matched_url?: string | null
> } | null
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   matched_by?: id | linkedin_id | linkedin_url | email | name_and_company
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### enrichSearch

`people.enrichSearch`

Enrich Mobiles for a Search. Credit cost: phone number found (always, until the balance runs out).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.people.enrichSearch({
	body: {
		filters: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: phone number found; always, until the balance runs out. Check the workspace balance and the provider response before repeating the request.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   exclude_ids?: string[],
>   limit?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people_enrich_search,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     requested: number,
>     truncated: boolean,
>     found: number,
>     already_not_found: number,
>     stopped_reason: string | null,
>     capped_by_plan?: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### get

`people.get`

Get a Person. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.get({
	path: { id: '64f1a2b3c4d5e6f7a8b9c0d1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   full_name: string | null,
>   first_name: string | null,
>   last_name: string | null,
>   email: {
>     status: valid | not_found | not_checked | searching | null,
>     address: string | null,
>     domain: string | null,
>     domain_status: valid | invalid | accept_all | disposable | unknown | null,
>     provider: string | null,
>     verified_at: string | null,
>     checked_at: string | null,
>     revealed: boolean,
>     retry_after?: number
>   },
>   mobile_phone: {
>     status: not_requested | found | not_found | error | null,
>     number: string | null,
>     numbers: string[],
>     revealed: boolean,
>     checked_at: string | null
>   },
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     time_zone: string | null,
>     time_zone_offset: number | null
>   } | null,
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   followers: number | null,
>   primary_position: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   } | null,
>   other_positions?: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   }[],
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     lists: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       first_name?: string,
>       last_name?: string,
>       email?: string,
>       phone?: string
>     }
>   } | null,
>   matched_url?: string | null
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   matched_by?: id | linkedin_id | linkedin_url | email | name_and_company
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### save

`people.save`

Save People. Credit cost: person whose valid email is handed over and was not already owned (always; a re-save of a person already paid for is free. A person answered `searching` costs nothing until the refreshed search finds an email and the balance allows it).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.people.save({
	body: {
		data: ['x'],
		list_ids: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: person whose valid email is handed over and was not already owned; always; a re-save of a person already paid for is free. A person answered `searching` costs nothing until the refreshed search finds an email and the balance allows it. Check the workspace balance and the provider response before repeating the request.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: (string | {
>     identifier?: string,
>     id?: string,
>     linkedin_url?: string,
>     primary_position_id?: string,
>     primary_position_index?: number,
>     primary_company_id?: string
>   })[],
>   list_ids: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   saved: {
>     identifier: string,
>     id: string,
>     matched_by: string,
>     list_ids: string[],
>     saved_at: string | null,
>     email: {
>       status: string | null,
>       address: string,
>       revealed: true
>     } | {
>       status: searching,
>       address: string | null,
>       revealed: false,
>       retry_after?: number
>     } | null
>   }[],
>   not_matched: {
>     identifier: string,
>     attempted: string[]
>   }[],
>   invalid: {
>     identifier: string,
>     reason: string,
>     skipped?: string[],
>     unknown_fields?: string[]
>   }[],
>   failed: {
>     identifier: string,
>     id: string,
>     reason: string
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   total: number,
>   saved_count: number,
>   not_matched_count: number,
>   invalid_count: number,
>   failed_count: number,
>   credits?: {
>     wallet_usd?: number
>   } | null
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### saveSearch

`people.saveSearch`

Save a Whole Search. Credit cost: person whose stored valid email is handed over and was not already owned (always, in search order, until the balance runs out).

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.people.saveSearch({
	body: {
		filters: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: person whose stored valid email is handed over and was not already owned; always, in search order, until the balance runs out. Check the workspace balance and the provider response before repeating the request.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   list_ids?: string[],
>   search_id?: string,
>   exclude_ids?: string[],
>   limit?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people_save_search,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     requested: number,
>     saved: number,
>     not_found: number,
>     stopped_reason: string | null,
>     truncated: boolean
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### search

`people.search`

People Search. Credit cost: newly revealed email; phone number found (only with enrich\_email / enrich\_phone).

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.people.search({
	body: {
		filters: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

Credit-aware operation: newly revealed email; phone number found; only with enrich\_email / enrich\_phone. Check the workspace balance and the provider response before repeating the request.

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filters: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   page?: number,
>   per_page?: 25 | 50 | 100,
>   enrich_email?: boolean,
>   enrich_phone?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   full_name: string | null,
>   first_name: string | null,
>   last_name: string | null,
>   email: {
>     status: valid | not_found | not_checked | searching | null,
>     address: string | null,
>     domain: string | null,
>     domain_status: valid | invalid | accept_all | disposable | unknown | null,
>     provider: string | null,
>     verified_at: string | null,
>     checked_at: string | null,
>     revealed: boolean,
>     retry_after?: number
>   },
>   mobile_phone: {
>     status: not_requested | found | not_found | error | null,
>     number: string | null,
>     numbers: string[],
>     revealed: boolean,
>     checked_at: string | null
>   },
>   location: {
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     time_zone: string | null,
>     time_zone_offset: number | null
>   } | null,
>   linkedin_url: string | null,
>   linkedin_id: number | null,
>   followers: number | null,
>   primary_position: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   } | null,
>   other_positions?: {
>     job_title: string | null,
>     normalized_job_title: string | null,
>     seniority: string | null,
>     departments: string[],
>     start_date: string | null,
>     company: {
>       id?: string | null,
>       name?: string | null,
>       description?: string | null,
>       logo?: string | null,
>       website?: string | null,
>       email?: {
>         status: valid | not_found | not_checked | searching | null,
>         address: string | null,
>         domain: string | null,
>         domain_status: valid | invalid | accept_all | disposable | unknown | null,
>         provider: string | null,
>         verified_at: string | null,
>         checked_at: string | null,
>         revealed: boolean,
>         retry_after?: number
>       },
>       linkedin_url?: string | null,
>       social_networks?: {
>         linkedin_url: string | null,
>         facebook_url: string | null,
>         twitter_url: string | null,
>         instagram_url: string | null,
>         youtube_url: string | null,
>         tiktok_url: string | null,
>         crunchbase_url: string | null,
>         github_url: string | null,
>         pinterest_url: string | null
>       },
>       industry?: string | null,
>       keywords?: string[],
>       naics_codes?: number[],
>       ai_industries?: string[],
>       type?: string | null,
>       business_type?: string | null,
>       revenue_stream?: string | null,
>       founded?: number | null,
>       employee_count?: number | null,
>       employee_range?: string | null,
>       location?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       } | null,
>       other_locations?: {
>         city: string | null,
>         state: string | null,
>         state_code: string | null,
>         country: string | null,
>         country_code: string | null,
>         raw_address: string | null
>       }[],
>       technologies?: {
>         id: string,
>         name: string,
>         icon_url: string | null,
>         website: string | null,
>         categories: {
>           id: string,
>           name: string
>         }[]
>       }[],
>       technologies_checked_at?: string | null
>     } | null,
>     position_index: number,
>     id: string | null
>   }[],
>   saved: {
>     id: string | null,
>     saved_at: string | null,
>     lists: {
>       id: string,
>       name: string | null,
>       created_at: string | null
>     }[],
>     edits?: {
>       first_name?: string,
>       last_name?: string,
>       email?: string,
>       phone?: string
>     }
>   } | null,
>   matched_url?: string | null
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   sort_by: string,
>   sort_direction: asc | desc,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page: number,
>     truncated: boolean,
>     total_is_estimate: boolean
>   },
>   company_filter?: {
>     truncated: true,
>     companies_matched: number,
>     companies_used: number,
>     filters: string[]
>   },
>   sort_ignored?: {
>     requested_sort_by: string,
>     requested_sort_direction: asc | desc | null,
>     reason: too_many_results,
>     max_results: number
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Search

### matchingTitles

`search.matchingTitles`

Matching Job Titles. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.search.matchingTitles({
	body: { boolean_search: 'xx' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   boolean_search: string,
>   limit?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   title: string,
>   count: number
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   limit: number,
>   returned: number,
>   cached: boolean
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### smartJobTitles

`search.smartJobTitles`

Smart Job Titles. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.search.smartJobTitles({
	body: {
		job_titles: ['x'],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   job_titles: string[],
>   exclude_job_titles?: string[],
>   filters?: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   intent: string,
>   titles: {
>     title: string,
>     level: SAME_ROLE | SIMILAR | RELATED,
>     new_people: number | null
>   }[],
>   exclude_titles: {
>     title: string,
>     removed_people: number | null
>   }[]
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   cached: boolean
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### suggest

`search.suggest`

Search Suggestions. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.search.suggest({
	body: { type: 'location' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `undefined` | No | — |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   type: location | job_title | industry | company_keywords | person | company | technology,
>   query?: string,
>   limit?: number,
>   ids?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> (
>   {
>     type: location,
>     value: string,
>     level: region | country | state | city,
>     city: string | null,
>     state: string | null,
>     state_code: string | null,
>     country: string | null,
>     country_code: string | null,
>     country_codes?: string[]
>   } | {
>     type: job_title,
>     value: string
>   } | {
>     type: industry,
>     value: string,
>     group: string
>   } | {
>     type: company_keywords,
>     value: string,
>     company_count: number
>   } | {
>     type: person,
>     value: string,
>     id: string,
>     job_title: string | null,
>     company: {
>       id: string,
>       name: string,
>       logo: string | null
>     } | null,
>     linkedin_url: string | null,
>     saved: boolean
>   } | {
>     type: company,
>     value: string,
>     id: string,
>     domain: string | null,
>     logo: string | null,
>     industry: string | null,
>     employee_range: string | null,
>     linkedin_url: string | null,
>     saved: boolean
>   } | {
>     type: technology,
>     value: string,
>     kind: technology | category,
>     id: string,
>     name: string,
>     icon_url?: string | null,
>     category_names?: string[],
>     company_count: number
>   }
> )[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   type: location | job_title | industry | company_keywords | person | company | technology,
>   query: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

## Trash

### companiesAdd

`trash.companiesAdd`

Delete Companies to Trash. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.trash.companiesAdd({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     lists?: {
>       saved?: any | none | without_list,
>       include?: string[],
>       exclude?: string[]
>     }
>   },
>   sort_by?: company_name | company_employee_count | company_industry | company_country | company_founded | company_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: companies_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     deleted: number,
>     skipped: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### list

`trash.list`

List Trash. Credit cost: none.

**Risk:** `read`

```ts theme={null}
await corsair.getprospect.api.trash.list({
	query: {
		kind: 'person',
		search: 'x',
		since: 'x',
		page: 1,
		per_page: 1,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `object` | Yes | — |
| `headers` | `undefined` | No | — |
| `body` | `undefined` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   kind: person | company | list,
>   search?: string,
>   since?: string,
>   page?: number,
>   per_page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object[]` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   kind: person | company | list,
>   name: string,
>   detail: string | null,
>   lists: {
>     id: string,
>     name: string,
>     deleted: boolean
>   }[],
>   deleted_by: {
>     id: string,
>     name: string
>   } | null,
>   deleted_at: string,
>   expires_at: string,
>   cascade_of_list: {
>     id: string,
>     name: string
>   } | null,
>   member_count?: number,
>   list_type?: people | companies
> }[]
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string,
>   pagination: {
>     page: number,
>     per_page: number,
>     total_pages: number,
>     total_count: number,
>     max_page?: number,
>     truncated?: boolean
>   }
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### peopleAdd

`trash.peopleAdd`

Delete People to Trash. Credit cost: none.

**Risk:** `destructive`

```ts theme={null}
await corsair.getprospect.api.trash.peopleAdd({
	headers: { idempotencyKey: 'stable-test-key' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   filters?: {
>     person?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       linkedin_url?: {
>         include?: string[]
>       }
>     },
>     person_location?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_keywords?: {
>       include: string[],
>       exclude?: string[],
>       include_all?: boolean,
>       sources?: (specialties | social_media_description | website_pages)[]
>     },
>     person_job_title?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: CONTAINS | EXACT | SMART,
>       smart_level?: SAME_ROLE | SIMILAR | RELATED,
>       boolean_search?: string
>     },
>     person_seniority?: {
>       include?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[],
>       exclude?: (Owner | C-Suite | Partner | VP | Head | Director | Manager | Senior | Mid-level | Entry | Intern | Unpaid)[]
>     },
>     person_department?: {
>       include?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[],
>       exclude?: (C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture, Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic, Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography, Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy, Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing)[]
>     },
>     person_months_in_current_role?: {
>       min?: number,
>       max?: number
>     },
>     person_months_in_current_company?: {
>       min?: number,
>       max?: number
>     },
>     person_job_change?: {
>       timeframe_months: number,
>       change_type?: any | promotion | new_company
>     },
>     company?: {
>       id?: {
>         include?: string[],
>         exclude?: string[]
>       },
>       domain?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: ORGANIZATION | PRIMARY | LINKEDIN_WEBSITE
>       },
>       name?: {
>         include?: string[],
>         exclude?: string[],
>         match_mode?: EXACT | CONTAINS
>       },
>       linkedin_id?: {
>         include?: number[],
>         exclude?: number[]
>       },
>       linkedin_url?: {
>         include?: string[],
>         exclude?: string[]
>       }
>     },
>     company_industry?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     company_headcount_range?: (1-10 | 11-50 | 51-200 | 201-500 | 501-1000 | 1001-5000 | 5001-10000 | 10001+)[],
>     company_country?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_type?: {
>       include?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[],
>       exclude?: (Privately Held | Public Company | Non Profit | Self Owned | Self Employed | Partnership | Educational | Government Agency | Unknown)[]
>     },
>     company_business_type?: {
>       include?: (B2B | B2C | Nonprofit | Unknown)[],
>       exclude?: (B2B | B2C | Nonprofit | Unknown)[]
>     },
>     company_revenue_stream?: {
>       include?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[],
>       exclude?: (Professional Services | Product Sales | Grants / Donations | Subscriptions / Recurring | Project / Contract Work | Event / Experience Revenue | Transaction Fees | Rental / Leasing | Advertising | Financial Services | Licensing / IP | Unknown)[]
>     },
>     company_ai_industry?: {
>       include?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[],
>       exclude?: (Software and IT | Healthcare and Life Sciences | Finance and Insurance | Energy, Utilities and Environmental Services | Industrial Manufacturing and Materials | Real Estate and Construction | Retail and Consumer Channels | Transportation and Logistics | Professional, Business and Legal Services | Education and Training | Media, Entertainment and Culture | Hospitality, Food and Travel Services | Personal and Home Services | Agriculture, Forestry and Fisheries | Automotive, Aerospace and Defense Manufacturing | Non-Profit, Public Sector and Education (Non-Commercial) | AI and ML Platforms | Agriculture and Forestry Software | Blockchain and Web3 | Carriers and ISPs | Cloud and Infrastructure Software | Consumer Software | Data and Analytics Software | Developer Tools and Platforms | Enterprise Software Solutions | Financial Services Software | Government and Public Sector Software | Hardware and Networking | Healthcare Software | IoT and Embedded Systems Software | IT Services and Cybersecurity | Manufacturing Software | Metaverse, AR/VR and Other Emerging Platforms | Quantum Computing Software | Real Estate and PropTech Software | Retail and Ecommerce Software | Security and Identity Software | Biotechnology and Pharmaceuticals | Digital Health and Telemedicine | Hospitals, Clinics and Outpatient Care | Medical Devices and Diagnostic Equipment | Medical Testing and Clinical Laboratories | Mental Health and Rehabilitation Services | Pharma Distribution and CRO Services | Banking and Lending | Capital Markets and Cryptocurrency | Cryptocurrency and Blockchain Services | Financial Services Platforms | Insurance and InsurTech | Investment Management and WealthTech | Venture Capital and Private Equity | Electric Power and Grid Management | Nuclear and Advanced Generation | Oil and Gas Exploration, Production and Services | Renewable Energy and Clean Tech | Sustainability Tech and Environmental Consulting | Water, Waste and Environmental Management | 3D Printing and Advanced Manufacturing | Building Materials and Chemicals | Consumer Goods and Appliances | Electronics and Computer Equipment | Food, Beverage and Tobacco Production | Industrial Machinery and Equipment | Mining, Metals and Natural Resources | Architecture, Urban Planning and Green Building | Commercial Real Estate Development and Leasing | Construction and Civil Engineering Services | Property and Facility Management | Residential Real Estate Development and Brokerage | Specialty Construction Products | Automotive Service and Collision Repair | Brick-and-Mortar Retail | Media and Entertainment Retail | Online Commerce and Marketplaces | Retail Technology | Specialty Auctions and Collectibles | Wholesale and Distribution | Autonomous Vehicles and Drone Delivery | Car and Truck Rental | Freight and Cargo | Logistics Technology | Passenger Transit and Mobility | Warehousing, Fulfillment and 3PL Services | Accounting, Audit and Financial Advisory | Advertising, Marketing and Multimedia Design | Defense and Government Services | Facilities Management and Commercial Cleaning | Human Resources, Staffing and Recruitment | Legal Services and Regulatory Compliance | Management Consulting and Strategy Consulting | Translation, Document and Information Management | Corporate Training and Learning and Development | E-Learning Platforms and EdTech | K-12 and Higher Education Institutions | Test Prep, Tutoring and After-School Services | Vocational Training and Certification Programs | Digital Publishing and Streaming Platforms | Film, Television and Broadcasting | Gaming, Esports and Interactive Entertainment | Live Events, Experiences and Ticketed Attractions | Museums, Art Galleries and Cultural Preservation | Music, Audio and Podcast Services | Sports and Recreation | Food and Beverage Services | Hospitality and Lodging | Travel Agencies and Leisure Services | Funeral Homes and Related Services | Home Services | Personal Care and Wellness | Veterinary Care and Pet Services | AgriTech and Precision Farming | Aquaculture and Fisheries | Crop Farming and Livestock Production | Farming Equipment and Supplies | Forestry, Logging and Wood Products | Mining and Extraction | Aviation and Aerospace Component Manufacturing | Automotive and Rental Retail | Commercial Space Innovation | Defense Systems and Marine Manufacturing | Motor Vehicle and Parts Manufacturing | Government Administration and Municipal Services | NGOs, Charities and Community Organizations | Public Healthcare and Social Services | Public/Private Research Institutions and Educational Foundations | Student Organizations and Campus Services)[]
>     },
>     company_founded?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_custom?: {
>       min?: number,
>       max?: number
>     },
>     company_headcount_by_department?: {
>       department: C-Suite | Consulting | Design | Education & Coaching | Engineering & Technical | Finance | Human Resources | Information Technology | Legal | Marketing | Medical & Health | Operations | Procurement & Purchasing | Product | Sales | Account Executive | Account Management | Accounting | Administrative & Office Support | Advertising | Anesthesiology | Architecture & Interior Design | Artificial Intelligence & Machine Learning | Banking & Investment | Bioengineering | Brand Management | Business Analysis | Business Development | Business Intelligence & Data Warehouse | Buying & Merchandising | Call Center | Channel Sales | Chemical Engineering | Chiropractics | Civil & Structural Engineering | Clinical Research | Clinical Systems | Cloud & Infrastructure | Coach & Trainer | Compensation & Benefits | Compliance & Privacy | Construction | Consultant | Content Marketing | Contracts | Corporate Secretary | Culture,
>       Diversity & Inclusion | Customer Experience | Customer Marketing | Customer Retention & Development | Customer Service & Support | Customer Success | Data Center & Servers | Data Engineering | Data Management & Governance | Data Science & Analytics | Database Administration | Dentistry | Dermatology | DevOps & SRE | Digital Marketing | Doctors & Physicians | eCommerce Development | eCommerce Marketing | Education Administration | Electrical & Hardware Engineering | Emergency Medical Services | Employee & Labor Relations | Engineering Management | Enterprise Architecture | Epidemiology | ERP Systems | Ethics & Governance | Event & Field Marketing | Executive | Facilities Management | Field & Outside Sales | Finance Executive | Financial Planning & Analysis | Financial Reporting | Financial Risk | Financial Systems | Founder | Governmental Affairs & Regulatory Law | Graphic,
>       Web & Brand Design | Growth & Demand Generation | Health & Safety | Help Desk & Desktop Services | Hospitality & Food Service | HR Business Partner | Human Resources Executive | Implementation & Onboarding | Industrial & Fashion Design | Industrial Engineering | Infectious Disease | Information Security | Information Technology Executive | Inside Sales | Insurance & Actuarial | Intellectual Property & Patent | Internal Audit & Control | Investor Relations | IT Asset Management | IT Audit & IT Compliance | IT Operations | IT Procurement | IT Strategy | Lawyer & Attorney | Lead Generation | Learning & Development | Legal Counsel | Legal Executive | Legal Operations | Litigation & eDiscovery | Logistics & Transportation | Maintenance & Repair | Manufacturing & Production | Marketing Analytics & Insights | Marketing Communications | Marketing Executive | Marketing Operations | Mechanical Engineering | Medical & Health Executive | Medical Administration | Medical Assistants & Technicians | Medical Education & Training | Mergers & Acquisitions | Mobile Development | Networking | Neurology | Nursing | Nutrition & Dietetics | Obstetrics & Gynecology | Oncology | Operations Executive | Ophthalmology & Optometry | Organizational Development | Orthopedics | Paralegal & Legal Support | Partnerships & Alliances | Pathology | Pediatrics | People Operations | Pharmacy | Photography,
>       Video & Media Production | Physical Security | Physical Therapy | Principal | Product & UX/UI Design | Product Development | Product Executive | Product Management | Product Marketing | Product Operations | Professor | Project Management | Psychiatry | Psychology | Public Health | Public Relations | Quality Management | Radiology | Real Estate | Real Estate Finance | Recruiting & Talent Acquisition | Research & Development | Retail Sales | Revenue Operations | Sales Development (SDR/BDR) | Sales Enablement & Training | Sales Engineering & Solutions | Sales Leader | Sales Operations | Scrum Master & Agile Coach | SEO & Paid Search | Social Media & Influencer Marketing | Social Work & Counseling | Software Development | Store & Retail Operations | Strategic Sourcing | Strategy,
>       Innovation & Transformation | Supply Chain | Sustainability & ESG | Talent Management | Tax | Teacher | Technical Support | Technician | Telecommunications | Test & Quality Assurance | Treasury | Vendor & Supplier Management | Veterinary | Web Development | Workforce Management | Writing & Editing,
>       location?: string,
>       min?: number,
>       max?: number
>     }[],
>     company_naics?: {
>       include?: number[],
>       exclude?: number[]
>     },
>     company_location?: {
>       include?: string[],
>       exclude?: string[],
>       headquarters_only?: boolean
>     },
>     company_technologies?: {
>       include?: string[],
>       exclude?: string[],
>       match_mode?: ANY | ALL
>     },
>     company_technology_categories?: {
>       include?: string[],
>       exclude?: string[]
>     },
>     contact_details?: {
>       email?: {
>         status?: (valid | invalid | accept_all | not_found)[],
>         revealed?: boolean
>       },
>       phone?: {
>         status?: (found | not_found | unknown)[],
>         revealed?: boolean
>       }
>     },
>     lists?: {
>       include?: string[],
>       exclude?: string[],
>       saved?: any | none | without_list,
>       saved_at?: {
>         from?: string,
>         to?: string
>       }
>     },
>     duplicates?: {
>       exclude_exported?: boolean
>     },
>     max_person_per_company?: number
>   },
>   sort_by?: person_first_name | person_last_name | person_seniority | company_employee_count | company_name | company_industry | person_country | company_founded | person_email_available | person_job_title | company_country | company_type | company_business_type | company_revenue_stream | person_saved_at,
>   sort_direction?: asc | desc,
>   limit?: number,
>   exclude_ids?: string[],
>   extra_ids?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: people_delete,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     deleted: number,
>     skipped: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***

### restore

`trash.restore`

Restore from Trash. Credit cost: none.

**Risk:** `write`

```ts theme={null}
await corsair.getprospect.api.trash.restore({
	headers: { idempotencyKey: 'stable-test-key' },
	body: { kind: 'person' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `undefined` | No | — |
| `query` | `undefined` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   idempotencyKey?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   kind: person | company | list,
>   ids?: string[],
>   all?: boolean,
>   search?: string,
>   since?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `data` | `object` | Yes | — |
| `metadata` | `object` | Yes | — |
| `errors` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   type: trash_restore,
>   status: queued | running | awaiting_confirmation | done | failed | cancelled,
>   total: number | null,
>   processed: number | null,
>   progress_percent: number | null,
>   error: string | null,
>   resource_url: string | null,
>   created_at: string | null,
>   finished_at: string | null,
>   result: {
>     restored: number,
>     lists_restored: number,
>     skipped: number
>   }
> }
> ```

> [accordion] metadata full type
>
> ```ts theme={null}
> {
>   timestamp: string
> }
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> {
>   name: VALIDATION_ERROR | UNAUTHORIZED | PAYMENT_REQUIRED | FORBIDDEN | NOT_FOUND | NOT_SAVED | TIMEOUT | REQUEST_TIMEOUT | CONFLICT | GONE | LIST_TOO_LARGE | TOO_MANY_LISTS | LIMIT_REACHED | RATE_LIMIT | TOO_MANY_CONCURRENT_REQUESTS | INTERNAL_ERROR | SAVE_FAILED | EXPORT_FAILED | UPSTREAM_ERROR | UNAVAILABLE | bulk_action_running | VERIFICATION_ERROR,
>   message: string,
>   payload?: {
>     code?: unknown_field | conflicting_fields | missing_field | wrong_type | value_not_allowed | out_of_range | invalid_format | invalid_value | session_required | admin_required | idempotency_key_reused | idempotency_in_progress | idempotency_response_unavailable | idempotency_outcome_unknown | ai_daily_limit | idempotency_unavailable | bulk_action_running | invalid_state | limit_reached | results_unavailable | results_expired | rate_limit_exceeded | job_exceeds_plan_limit | billing_operation_in_progress | cancellation_cooling_down | payment_state_unknown | temporarily_disabled | slug_taken | payment_captured_update_failed | payment_processing_failed | payment_declined | use_checkout | use_fastspring_order | use_phone_addon_update | phone_addon_requires_plan | not_eligible | plan_not_found | billing_cycle_not_found | subscription_not_found | no_stripe_customer | account_not_owned | coupon_invalid | coupon_own_workspace | account_not_new | coupon_already_applied | retention_offer_invalid | payout_profile_missing | minimum_balance | payout_request_open | payout_profile_conflict | already_pending | not_reviewable | email_taken | phone_taken | not_required | deletion_blocked | already_verified | expired | no_bounce | already_kept | cannot_reactivate | in_progress | charge_lock_busy | already_member | already_invited | cannot_remove_admin | invite_limit_reached | workspace_required | integration_not_connected | integration_paused | activation_blocked | connection_owner_only | spreadsheet_missing | push_all_starting | vendor_auth_failed | vendor_permission_missing | vendor_rate_limited | vendor_unavailable | vendor_rejected | creator_removed | creator_mismatch | credential_in_query | ticket_invalid | token_expired | too_many_tickets | too_many_streams | oauth_exchange_failed | email_missing | mailbox_error | not_draft | not_launched | sequence_not_draft | sequence_completed | plan_required | mailbox_missing | mailbox_disconnected | mailbox_inactive | mailbox_bounce_rate | dns_invalid | no_steps | first_step_subject_missing | schedule_missing | step_body_empty | no_leads | step_limit | last_step | last_variant | not_a_permutation | liquid_syntax | lead_opted_out | liquid_render_failed | attachment_limit | upload_not_found | upload_purpose_mismatch | default_schedule | folder_cycle | mailbox_send_failed | too_many_recipients | already_exists,
>     field?: string,
>     received_value?: JsonValue,
>     received_type?: string,
>     invalid_values?: JsonValue,
>     allowed_values?: (string | number)[],
>     enum?: string,
>     did_you_mean?: string,
>     suggested_values?: {
>       value: JsonValue,
>       suggestions: string[]
>     }[],
>     position?: number,
>     allowed_fields?: string[],
>     constraints?: Record<string, string>
>   }
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.