LEleadfeeder
Ideal Customer Profiles
v1

Get Ideal Customer Profile Details

Changed on

Get the details of a specific Ideal Customer Profile (ICP) by ID, including its name, creation timestamp, and the full set of filter criteria that define it. relationships.custom_feed links the ICP to the Web Visits custom feed created alongside it, which lists the visiting companies matching the ICP; it is null for the few ICPs that have no feed.

Credit Note: Retrieving an ICP definition does not consume credits.

:::info Requires the icps:read OAuth2 scope. :::

get/v1/icps/{id}

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/icps/{id}
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: icps:read

Path parameters

idstring required

The ICP ID.

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Response

Success

Example response

{
  "data": {
    "attributes": {
      "created_at": "2024-12-10T15:57:25Z",
      "filters": {
        "employee_count": [
          {
            "display_value": "United States",
            "search_value": "US"
          }
        ],
        "industries": [
          {
            "display_value": "United States",
            "search_value": "US"
          }
        ],
        "location": [
          {
            "display_value": "United States",
            "search_value": "US",
            "type": "country_code"
          }
        ]
      },
      "name": "US Prospects"
    },
    "id": "6080",
    "relationships": {
      "custom_feed": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "custom_feed"
      }
    },
    "type": "icp"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • 09a5f5bf0a85Revision changes
    • info

      added the required property / to the response with the status

  • ac752c6c2be0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status