Base URL
All Persona 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.
Persona Object
A Persona defines the types of people who are most likely to influence, evaluate, or purchase your products and services. Personas typically describe a buyer’s role, responsibilities, seniority, business challenges, and purchasing priorities. For example, Snowbricks, a fictional cloud data and AI platform, might target VPs of Data Engineering, Heads of Analytics, and Chief Data Officers at companies investing in modern data infrastructure.Fields
Example Persona
System-Managed Fields
1eye automatically generates and maintains additional fields.
These fields are read-only and cannot be modified through Create or Update requests.
Persona identifiers use the
per_ prefix.
Example:
1. List Personas
GET /v1/kb/personas
Retrieve a paginated list of Personas configured in your workspace.
Query Parameters
Example Request
Example Response
200 OKPagination
List Personas uses cursor-based pagination. When additional results are available,pagination.next_cursor contains a continuation token.
Pass this token using the cursor parameter to retrieve the next page.
next_cursor is null, there are no additional results.
For more information, see Pagination.
Behavior
- Returns Personas belonging to the authenticated workspace.
- Excludes soft-deleted Personas.
- Supports cursor-based pagination.
- Returns an empty
dataarray when no Personas exist. - Does not return Personas belonging to other workspaces.
2. Retrieve a Persona
GET /v1/kb/personas/{persona_id}
Retrieve a specific Persona using its unique identifier.
Path Parameters
Example Request
Example Response
200 OKBehavior
- Returns the complete Persona record.
- Includes system-generated metadata.
- The Persona must belong to the authenticated workspace.
- Returns
404 Not Foundif the Persona does not exist, has been deleted, or belongs to another workspace.
3. Create a Persona
POST /v1/kb/personas
Create a new Buyer Persona in your workspace.
New Personas become available for future Buyer evaluations and matching.
Request Body
Example Request
Example Response
201 CreatedBehavior
When a Persona is created:- 1eye generates a unique Persona ID.
- The Persona is associated with your workspace.
- The Persona becomes visible in the Knowledge Base.
- The Persona becomes available for future Buyer evaluations.
- The Persona can immediately be retrieved or updated through the API.
Validation
namemust not be empty.short_namemust not be empty.descriptionmust not be empty.short_namemust be unique among active Personas in the workspace.- System-managed fields cannot be supplied in the request.
4. Update a Persona
PATCH /v1/kb/personas/{persona_id}
Update an existing Persona using its unique identifier.
The API supports partial updates. You only need to provide the fields you want to change.
Path Parameters
Request Body
At least one editable field must be supplied.
Example Request
Update the Persona description to include additional technical and business responsibilities.Example Response
200 OKPartial Updates
Only the fields supplied in the request are updated. For example:short_name or description.
Behavior
- Updates the existing Persona.
- Preserves fields not included in the request.
- Preserves the original Persona ID.
- Updates the modification timestamp.
- Reflects changes in the 1eye Console.
- Uses the updated Persona definition for future Buyer evaluations.
5. Delete a Persona
DELETE /v1/kb/personas/{persona_id}
Delete a Persona from your workspace.
Deleting a Persona performs a soft delete. The Persona is removed from active use but is not permanently erased from 1eye.
Path Parameters
Example Request
Response
204 No Content The response body is empty.What Happens When a Persona Is Deleted?
- The Persona is removed from the active Knowledge Base.
- The Persona no longer appears in List Personas results.
- Retrieving the deleted Persona returns
404 Not Found. - The Persona is excluded from future Buyer evaluations.
- The deleted Persona is removed from active Buyer Persona associations.
- Historical Persona information is preserved internally.
Impact on Existing Buyers
Deleting a Persona does not delete Buyers previously associated with that Persona. For example, Snowbricks might have identified a Buyer matching the VP of Data Engineering Persona. Before deletion:Important Considerations
Deleting a Persona does not:- Delete Buyers.
- Delete Signals.
- Delete associated companies.
- Permanently erase historical evaluations.
- Delete previously synchronized CRM contacts.
- Automatically trigger new Buyer evaluations.
6. Error Handling
All Persona endpoints use the standard 1eye API error format.Example Error
Attempting to retrieve a Persona that does not exist: 404 Not FoundValidation Errors
Invalid requests return an error identifying the issue. Examples include:- Missing Persona name.
- Missing short name.
- Empty description.
- Duplicate short name.
- Invalid Persona ID.
- Attempting to modify system-managed fields.
7. Pagination & Rate Limits
Pagination
List Personas supports the existing 1eye cursor-based pagination mechanism.- Default page size: 100.
- Maximum page size: 1,000.
- Use
cursorto retrieve subsequent pages. - A
nullnext cursor indicates the end of the collection.
Rate Limits
Persona API requests count toward your workspace’s API rate limits. Rate limits are shared across all API keys belonging to the same workspace. If a limit is exceeded, the API returns: 429 Too Many Requests Follow theRetry-After header when provided.
See Rate Limits.
8. How Personas Affect Buyer Intelligence
Personas help 1eye determine which people within your target companies are most relevant to your products and GTM strategy. The Knowledge Base is used by the REEM pipeline: Resolve → Enrich → Evaluate → MatchICPs vs. Personas
For example, Snowbricks might have:
ICP: Cloud-Native SaaS Companies
Persona: VP of Data Engineering
1eye evaluates company fit against the ICP and contact fit against the Persona.
Together, these configurations help identify Buyers who are relevant to Snowbricks’ go-to-market strategy.
Impact of Persona Changes
Existing Buyer Evaluations
Creating or updating a Persona does not automatically reevaluate existing Buyers. Existing evaluations are preserved until the normal REEM pipeline processes them again.Deleting a Persona
Deleting a Persona removes its active Buyer associations without deleting underlying Buyer records or historical Signals.Console Synchronization
All changes are reflected in the 1eye Console.- Personas created through the API appear in the Console.
- Console updates are reflected in API responses.
- Deleted Personas no longer appear in active Knowledge Base views.
9. Best Practices
Use Role-Based Persona Names
Choose names that clearly identify the decision-maker or buyer segment. For Snowbricks, examples include:- VP of Data Engineering
- Head of Analytics
- Chief Data Officer
- Director of Data Platform
- Head of Machine Learning
Use Consistent Short Names
Short names should be concise, descriptive, and unique within your workspace. Examples:Write Detailed Persona Descriptions
Persona descriptions should explain who the buyer is, what they are responsible for, and why they are relevant to your product. Useful information includes:- Common job titles.
- Department or business function.
- Seniority level.
- Primary responsibilities.
- Technology ownership.
- Budget and purchasing authority.
- Business challenges.
- Buying priorities.
- Relevant evaluation or purchasing triggers.
Include Related Job Titles
A Persona should represent a meaningful buyer segment, not necessarily one exact job title. For example, a VP of Data Engineering Persona may include:- VP of Data Engineering
- Head of Data Engineering
- Director of Data Engineering
- Director of Data Platform