List ICPs

List every ICP on your account.

List ICPs

POST /list_icps

Free — no credits are charged. ICPs are scoped to the caller.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Your API Key.

Response

Field in each row	Type	Description
id	integer	The ICP id. Pass it to the other ICP endpoints.
name	string	ICP name.
summary	string	Plain-English summary of who the ICP targets.
nl_text	string	The description the ICP was built from.
match_threshold	number	Match cutoff used when scoring.
is_active	boolean	Whether the ICP is marked active.
params	object	The structured filters parsed out of the text.

The ICPs are under data, and total is how many there are. See Response Format for the fields every endpoint returns.

Example

Input

{
  "api_key": "your_api_key"
}

Output

{
  "status": "success",
  "data": [
    {
      "id": 26,
      "name": "Sales Director Small Company",
      "summary": "Targeting sales directors in companies with more than 10 employees.",
      "nl_text": "sales director for company having more than 10 headcount",
      "match_threshold": 0.7,
      "is_active": false,
      "params": { "deterministic_filters": { "seniority": ["Director"], "function": ["Sales"] } }
    }
  ],
  "total": 1,
  "credits_used": 0,
  "credits_remaining": 4005.0,
  "success": true
}