Skip to main content
GET
Get ICP
Retrieves the full details of an ICP (Ideal Customer Profile) by its unique identifier. ICPs define the criteria used to search for and filter leads from various providers, including lead provider search criteria, custom filtering rules, and CRM filters.

Authentication

This endpoint requires authentication. The user must be signed in.
Users can only access ICPs where they are listed in the userIds array, or if they are an admin user. Attempting to access an ICP without proper authorization will result in a 403 Forbidden error.

Request

string
required
The unique identifier (UUID) of the ICP to retrieve.

Response

Returns the complete ICP object.
string
required
Unique identifier (UUID) for the ICP.
string
required
The display name of the ICP.
string | null
required
A description of the ICP’s target profile. May be null.
string
required
ISO 8601 timestamp of when the ICP was created.
string
required
ISO 8601 timestamp of when the ICP was last updated.
array
required
Array of Clerk user IDs that have access to this ICP.
number
required
The default number of leads to include when generating lead lists from this ICP. Defaults to 10.
string | null
required
ISO 8601 timestamp indicating when the ICP expires. May be null for indefinite ICPs.
array
required
Array of search criteria configurations for lead providers.
array
required
Array of custom filtering rules applied to leads after retrieval.
object | null | undefined
Optional CRM filter configuration for integrations like Bullhorn. This field is both optional and nullable.

Response Examples

Error Codes