# Infer a company email format

Infer a company's email address format from published addresses. The response includes the format, confidence, supporting examples, evidence type, and optional generated addresses for supplied names.

- Platform: LinkedIn
- Request: `GET https://api.toolzerhub.com/v1/linkedin/company/email-pattern`
- Auth: `x-api-key` header
- Cost: 1 credit per successful request. Failed requests are not billed.
- Page: https://docs.toolzerhub.com/reference/linkedin/linked-in-company-email-pattern

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `domain` | query | yes | string | The company: its mail domain, its name, or a LinkedIn company URL. A name is resolved to a domain before the lookup. |
| `github_org` | query | no | string | Override the GitHub org slug. Normally omitted -- it is the richest free source and is found rather than asked for. |
| `names` | query | no | string | Optional comma-separated employee names to render under the learned rule, and to run the collision check against. |
| `resolve` | query | no | boolean | Derive the mail domain and GitHub org when they were not given. |
| `pattern` | query | no | string | Rule token from a previous response's email_pattern.token. Pass it to reuse an already-derived rule instead of deriving it again. |
| `max_candidates` | query | no | integer | Candidate addresses to propose per name, ranked cheapest-to-verify first. |
| `verify` | query | no | boolean | Confirm each rendered address against the mail server. A catch-all domain accepts every address, so verification is impossible there and is reported rather than attempted -- see domain_verifiable on the response. |

## Example request

```bash
curl "https://api.toolzerhub.com/v1/linkedin/company/email-pattern?domain=<domain>" \
  -H "x-api-key: $TOOLZERHUB_API_KEY"
```

Success responses are wrapped as `{ "data": ... }`. Errors return `{ "error": { "code", "status", "message", "retryable", "details" } }`. See https://docs.toolzerhub.com/docs/responses-and-errors.