Get recommendations ICP filters

Retrieve the Ideal Customer Profile (ICP) filters associated with the current user or a specific external user.

Returns the list of saved ICPs for calling POST /v2/recommendations/fetch. Use externalUserId to fetch ICPs belonging to a specific user in your system.

To create or update an ICP, see POST /v2/recommendations/icp.

Authorization

AuthorizationRequiredBearer <token>

In: header

Query Parameters

externalUserIdstring

External User ID

curl -X GET "https://api.surfe.com/v2/recommendations/icp?externalUserId=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{
  "icpFilters": [
    {
      "companies": {
        "employeeCount": {
          "from": 1,
          "to": 100000000
        },
        "industries": [
          "Software",
          "Finance"
        ],
        "primaryLocations": [
          "fr",
          "W-EMEA"
        ],
        "revenue": {
          "from": 1,
          "to": 100000000
        }
      },
      "id": "string",
      "people": {
        "countries": [
          "fr",
          "W-EMEA"
        ],
        "departments": [
          "Engineering",
          "Marketing"
        ],
        "jobTitles": [
          "Software Engineer",
          "Marketing Manager"
        ],
        "seniorities": [
          "Board Member",
          "C-Level",
          "Director",
          "Founder",
          "Head",
          "Manager",
          "Other",
          "Owner",
          "Partner",
          "VP"
        ]
      },
      "type": "DECLARED_ICP"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 0,
    "totalAmount": 0
  }
}

Get recommendations ICP filters

Authorization

Query Parameters

Response

TypeScript