Contacts search
Search contacts by company name. Use this endpoint when you want a lightweight contact result set keyed off a company query, with optional role filtering.Endpoint
GET /external/contacts/search
Authentication
See AuthenticationSuccess status code
200 OK
Query parameters
| Name | Required | Type | Notes |
|---|---|---|---|
company_name | Yes | string | Company name query, length 1 to 200. |
role | No | string | Optional role filter. Blank values are normalized away. |
page | No | integer | Defaults to 1. |
pageSize | No | integer | Defaults to 20; maximum 100. |
Response example
Error responses
400 Bad Request401 Unauthorized
Notes
- Email is intentionally not returned by this endpoint.
- Short company queries use a direct contains-style fallback; longer company queries use scored matching.
- Results are scoped to the authenticated user because the service computes user-specific reveal and task state before mapping the response.
- Contact-style list responses follow the shared Pagination conventions.