Base URL
All Exclusion API requests use:Authentication
All endpoints require a valid 1eye API key.$API_KEY as the environment variable containing your API key.
For more information, see Authentication.
Endpoints
All endpoints return JSON responses, except DELETE, which returns no response body.
Exclusion Object
An Exclusion represents a company that should not be treated as an eligible target for your business. For example, Snowbricks, a fictional cloud data and AI platform, might exclude its own organization to prevent internal company activity from being qualified as an external sales opportunity. Other common exclusions include existing customers, partners, investors, and companies that should not enter your GTM workflows.Fields
linkedin and logo are optional when creating an Exclusion.
Example Exclusion
System-Managed Fields
1eye automatically generates and maintains additional fields.
These fields are read-only.
1. List Exclusions
GET /v1/kb/exclusions
Retrieve a paginated list of excluded companies configured in your workspace.
Query Parameters
Example Request
Example Response
200 OKPagination
When additional results are available, usepagination.next_cursor to retrieve the next page.
next_cursor is null, there are no additional results.
See Pagination.
Behavior
- Returns Exclusions belonging to the authenticated workspace.
- Excludes deleted records.
- Supports cursor-based pagination.
- Returns an empty
dataarray when no exclusions exist.
2. Retrieve an Exclusion
GET /v1/kb/exclusions/{id}
Retrieve a specific Exclusion using its unique identifier.
Path Parameters
Example Request
Example Response
200 OKBehavior
- Returns the complete Exclusion record.
- Includes system-generated metadata.
- Returns
404 Not Foundif the Exclusion does not exist, has been deleted, or belongs to another workspace.
3. Create an Exclusion
POST /v1/kb/exclusions
Add a company to your workspace’s Exclusions.
The excluded company will no longer be considered an eligible target during future Buyer qualification and matching.
Request Body
Example Request
Example Response
201 CreatedBehavior
When an Exclusion is created:- 1eye generates a unique Exclusion ID.
- The company is associated with your workspace.
- The Exclusion appears in the Knowledge Base.
- The company becomes ineligible for future Buyer qualification and targeting.
- The Exclusion can be retrieved or updated through the API.
Validation
namemust not be empty.short_namemust not be empty.domainmust be valid.descriptionmust not be empty.linkedin, when supplied, must be a valid LinkedIn company URL.logo, when supplied, must be a valid image URL.short_namemust be unique among active Exclusions in the workspace.- System-managed fields cannot be supplied.
4. Update an Exclusion
PATCH /v1/kb/exclusions/{id}
Update an existing Exclusion.
Only supplied fields are modified.
Request Body
At least one editable field must be supplied.
Example Request
Example Response
200 OKBehavior
- Supports partial updates.
- Preserves omitted fields.
- Preserves the original Exclusion ID.
- Reflects changes in the Console.
- Uses updated exclusion information for future processing.
5. Delete an Exclusion
DELETE /v1/kb/exclusions/{id}
Remove a company from your workspace’s active Exclusions.
Deletion performs a soft delete of the Exclusion record.
Example Request
Response
204 No Content The response body is empty.What Happens When an Exclusion Is Deleted?
- The Exclusion is removed from the active Knowledge Base.
- It no longer appears in List Exclusions.
- Retrieving the deleted Exclusion returns
404 Not Found. - The company is no longer excluded by that configuration.
- The company may become eligible for future Buyer qualification, subject to other targeting rules.
- Historical company information and Signals remain preserved.
6. How Exclusions Affect Buyer Intelligence
Exclusions help prevent unwanted companies from entering your active go-to-market workflows. For example, Snowbricks might exclude:Exclusion Matching
1eye uses the configured company information to identify companies that should be excluded. The company domain provides a primary matching identifier, while additional company information may support identification.REEM Integration
Exclusions are applied during relevant Buyer evaluation and matching. Resolve → Enrich → Evaluate → Match When a company matches an active Exclusion, it should not be treated as an eligible target.Impact of Exclusion Changes
Existing Data
Exclusions do not permanently delete historical data. Existing Buyers and Signals remain available according to their normal access and visibility rules. Previously synchronized CRM contacts are not automatically deleted when an Exclusion is created.7. Exclusions vs. Competitors
Competitors and Exclusions use the same company information fields but serve different purposes.
A Competitor is not automatically an Exclusion.
For example, Snowbricks may monitor Databricks-related research as a buying signal without automatically excluding Databricks from every applicable workflow.
If a company should also be excluded from targeting, add it separately to Exclusions.
8. Flat Exclusion Management
Exclusions are managed as individual company records. You do not need to create an Exclusion List before adding companies. Each excluded company has its own resource identifier and can be managed directly through:9. Error Handling
All Exclusion endpoints use the standard 1eye API error format.Example Error
404 Not Found10. Pagination & Rate Limits
List Exclusions supports cursor-based pagination.- Default page size: 100.
- Maximum page size: 1,000.
- Use
cursorfor subsequent pages. next_cursor: nullindicates the end of the collection.