API Reference

List ICP templates

GET/v1/accounts/{accountGroupId}/icp-templates

Integration notes

Permissions

templates:read for reads and templates:write for create, update, and delete operations.

Follow-up

Template operations are synchronous. Read campaigns or content slots again when downstream state depends on a changed template.

Writing-style syntax

Samples support Spintax such as {Hi|Hello}, documented double-brace profile variables, and signal variables in signal samples. Sonarly renders them before approval; workflow-run edits require final text.

Parameters

accountGroupIdPath

Type: string

Account group ID that scopes the request.

Required

cursorQuery

Type: string

Opaque pagination cursor returned by the previous page.

Optional

limitQuery

Type: number

Maximum number of items to return in this page.

Optional

Request body

This endpoint does not define a request body.

Responses

200

Paginated ICP templates

Schema: IcpTemplateListSuccessResponse

400

Request validation failed

Schema: ValidationErrorResponse

401

Invalid or missing API key

Schema: ErrorResponse

403

Missing required permission

Schema: ErrorResponse

429

Rate limit exceeded

Schema: ErrorResponse

500

Internal server error

Schema: ErrorResponse

Response examples

200 Example JSONIcpTemplateListSuccessResponse

{
    "success": true,
    "data": {
        "items": [
            {
                "id": "507f1f77bcf86cd799439011",
                "name": "Avery Stone",
                "description": "string",
                "filters": {
                    "personTitleIncludes": [
                        "string"
                    ],
                    "personTitleExcludes": [
                        "string"
                    ],
                    "personTitleExtraIncludes": [
                        "string"
                    ],
                    "includeSimilarTitles": true,
                    "includeTitleVariants": true,
                    "seniorityIncludes": [
                        "string"
                    ],
                    "seniorityExcludes": [
                        "string"
                    ],
                    "personFunctionIncludes": [
                        "string"
                    ],
                    "personFunctionExcludes": [
                        "string"
                    ],
                    "functionIncludes": [
                        "string"
                    ],
                    "functionExcludes": [
                        "string"
                    ],
                    "personFirstNameIncludes": [
                        "Avery Stone"
                    ],
                    "personFirstNameExcludes": [
                        "Avery Stone"
                    ],
                    "personLastNameIncludes": [
                        "Avery Stone"
                    ],
                    "personLastNameExcludes": [
                        "Avery Stone"
                    ],
                    "personLocationCountryIncludes": [
                        "string"
                    ],
                    "personLocationCountryExcludes": [
                        "string"
                    ],
                    "personLocationStateIncludes": [
                        "string"
                    ],
                    "personLocationStateExcludes": [
                        "string"
                    ],
                    "personLocationCityIncludes": [
                        "string"
                    ],
                    "personLocationCityExcludes": [
                        "string"
                    ],
                    "companyNameIncludes": [
                        "Avery Stone"
                    ],
                    "companyNameExcludes": [
                        "Avery Stone"
                    ],
                    "companyNameMatchMode": "exact",
                    "companyDomainIncludes": [
                        "string"
                    ],
                    "companyDomainExcludes": [
                        "string"
                    ],
                    "companyDomainMatchMode": "strict",
                    "companyLocationCountryIncludes": [
                        "string"
                    ],
                    "companyLocationCountryExcludes": [
                        "string"
                    ],
                    "companyLocationStateIncludes": [
                        "string"
                    ],
                    "companyLocationStateExcludes": [
                        "string"
                    ],
                    "companyLocationCityIncludes": [
                        "string"
                    ],
                    "companyLocationCityExcludes": [
                        "string"
                    ],
                    "companyEmployeeSizeIncludes": [
                        "string"
                    ],
                    "companyEmployeeSizeExcludes": [
                        "string"
                    ],
                    "companySizeIncludes": [
                        "string"
                    ],
                    "companySizeExcludes": [
                        "string"
                    ],
                    "companyIndustryIncludes": [
                        "string"
                    ],
                    "companyIndustryExcludes": [
                        "string"
                    ],
                    "companyAudienceIncludes": [
                        "string"
                    ],
                    "companyKeywordIncludes": [
                        "string"
                    ],
                    "companyKeywordExcludes": [
                        "string"
                    ],
                    "technologiesIncludes": [
                        "string"
                    ],
                    "annualRevenueIncludes": [
                        "string"
                    ],
                    "totalFundingIncludes": [
                        "string"
                    ],
                    "fundingStageIncludes": [
                        "string"
                    ]
                },
                "source": "manual",
                "sourceUrl": "https://example.com/resource",
                "createdAt": "string"
            }
        ],
        "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTI4VDE1OjMwOjAwLjAwMFoifQ",
        "hasMore": true
    },
    "error": null,
    "traceId": "507f1f77bcf86cd799439011"
}

400 Example JSONValidationErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

401 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

403 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

429 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

500 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}