Profiles

A profile is your scoring configuration: the fields to extract, the criteria and their points, the tiers and the junk rules. Profiles are versioned: edit a draft, publish it, roll back to any earlier version.

The Profile object

Properties

  • Name
    object
    Type
    'profile'
    Description

    The object type.

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

  • Name
    workspaceId
    Type
    string
    Description

    The workspace this object belongs to.

  • Name
    name
    Type
    string
    Description

    Display name.

  • Name
    isDefault
    Type
    boolean
    Description

    Used when a source or request doesn't name a profile

  • Name
    activeVersion
    Type
    integer or null
    Description

    Version used for scoring; null until published

  • Name
    latestVersion
    Type
    integer
    Description

     

  • Name
    document
    Type
    ProfileDocument
    Description

     

  • Name
    draft
    Type
    object or null
    Description

     

  • Name
    createdAt
    Type
    string
    Description

    When it was created (ISO 8601).

  • Name
    updatedAt
    Type
    string
    Description

    When it was last changed (ISO 8601).


GET/v1/profiles

List profiles of the workspace

Query parameters

  • Name
    limit
    Type
    integer
    Description

    1–100, default 20

  • Name
    starting_after
    Type
    string
    Description

    ID of the last item of the previous page

Request

GET
/v1/profiles
curl https://core.leadveyor.com/v1/profiles \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "list",
  "data": [
    {
      "object": "profile",
      "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
      "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
      "name": "Home renovation",
      "isDefault": true,
      "activeVersion": 1,
      "latestVersion": 1,
      "document": {
        "schemaVersion": "2026-10",
        "name": "Home renovation",
        "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
        "extract": [
          {
            "key": "budget",
            "type": "money",
            "description": "Project budget"
          },
          {
            "key": "start_date",
            "type": "date",
            "description": "When the customer wants work to start"
          }
        ],
        "dimensions": [
          {
            "id": "what",
            "label": "What"
          },
          {
            "id": "when",
            "label": "When"
          }
        ],
        "criteria": [
          {
            "id": "budget_15k",
            "label": "Budget from $15k",
            "dimension": "what",
            "type": "rule",
            "condition": {
              "field": "fields.budget",
              "op": "gte",
              "value": 15000
            },
            "points": 30
          },
          {
            "id": "big_project",
            "label": "Kitchen, full home or extension",
            "dimension": "what",
            "type": "rule",
            "condition": {
              "field": "fields.project_type",
              "op": "in",
              "value": [
                "kitchen",
                "full_home"
              ]
            },
            "points": 20
          }
        ],
        "scoring": {
          "method": "sum",
          "maxGrade": 5
        },
        "tiers": [
          {
            "name": "hot",
            "minScore": 70
          },
          {
            "name": "warm",
            "minScore": 40
          }
        ],
        "junk": {
          "enabled": true,
          "extraRules": [
            "Offers of SEO, marketing or lead generation services are junk"
          ],
          "blockDomains": [],
          "allowDomains": []
        }
      },
      "draft": null,
      "createdAt": "2026-10-23T14:51:55.675Z",
      "updatedAt": "2026-10-23T14:51:55.684Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

POST/v1/profiles

Create a profile from a document or a template (saved as draft; ?publish=true publishes version 1)

Send a full profile document, or \{ templateId, variables, name \} to start from a built-in template (see GET /v1/templates).

Query parameters

  • Name
    publish
    Type
    'true' | 'false'
    Description

     

Request

POST
/v1/profiles
curl -X POST https://core.leadveyor.com/v1/profiles \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{}'

Response 201

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

POST/v1/profiles/validate

Validate a profile document without saving; returns all errors with paths

Request

POST
/v1/profiles/validate
curl -X POST https://core.leadveyor.com/v1/profiles/validate \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{}'

Response 200

{
  "object": "profile_validation",
  "valid": false,
  "errors": [
    {
      "path": "path",
      "message": "message"
    }
  ],
  "warnings": [
    {
      "path": "path",
      "message": "message"
    }
  ],
  "document": {
    "schemaVersion": "2026-10",
    "name": "name",
    "brief": "",
    "extract": [],
    "dimensions": [],
    "criteria": [],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [],
      "blockDomains": [],
      "allowDomains": []
    }
  }
}

POST/v1/profiles/criteria/generate

Draft a criterion from a plain-language description (AI); nothing is saved

Add the returned criterion to a draft with PUT or PATCH /v1/profiles/{id}/draft. Usually 3–8 s.

Required attributes

  • Name
    description
    Type
    string
    Description

    What to look for, in plain words; may include your own grade levels

Optional attributes

  • Name
    kind
    Type
    'graded' | 'escalate' | 'disqualify'
    Description

    graded: an ai criterion with grade levels; escalate: when met, the lead goes to the top tier; disqualify: when met, the lead is rejected

  • Name
    profile
    Type
    object
    Description

    The profile document being edited; its dimensions, grade scale, brief and criterion ids are used

Request

POST
/v1/profiles/criteria/generate
curl -X POST https://core.leadveyor.com/v1/profiles/criteria/generate \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Weddings are our best jobs. 5 if it'\''s a wedding, 3 for engagement parties, 1 for anything else.",
    "kind": "graded",
    "profile": {}
  }'

Response 200

{
  "object": "generated_criterion",
  "criterion": {
    "id": "id",
    "label": "label",
    "dimension": "dimension",
    "type": "rule",
    "condition": {
      "field": "field",
      "op": "eq",
      "value": "value"
    },
    "levels": [
      {
        "grade": 0,
        "points": 0,
        "description": "description",
        "condition": {}
      }
    ],
    "points": 0
  },
  "usage": {
    "costUsd": 0,
    "inputTokens": 0,
    "outputTokens": 0,
    "models": [
      "models"
    ]
  }
}

POST/v1/profiles/generate

Draft a whole profile from a description of the business (AI)

Creates a new profile whose draft is the generated document (not published): fields, criteria with points, escalations, disqualifiers, junk rules. Optionally starts from a template. Review, test (POST /v1/profiles/{id}/test) and publish it. Usually 10–30 s, about $0.02.

Required attributes

  • Name
    brief
    Type
    string
    Description

    The business and what a good lead is, in plain words: services, area, best customers, what you don't do

Optional attributes

  • Name
    name
    Type
    string
    Description

    Profile name; by default the AI names it

  • Name
    templateId
    Type
    string
    Description

    Start from this template (GET /v1/templates) and adapt it to the brief

  • Name
    variables
    Type
    object
    Description

    Template variables, with templateId

Request

POST
/v1/profiles/generate
curl -X POST https://core.leadveyor.com/v1/profiles/generate \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{
    "brief": "Plumbing business in Brisbane. Emergencies and bathroom renovations are our best jobs, we also do hot water systems. We don'\''t do commercial work or new builds.",
    "name": "name",
    "templateId": "temp_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
    "variables": {}
  }'

Response 201

{
  "object": "generated_profile",
  "profile": {
    "object": "profile",
    "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
    "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
    "name": "Home renovation",
    "isDefault": true,
    "activeVersion": 1,
    "latestVersion": 1,
    "document": {
      "schemaVersion": "2026-10",
      "name": "Home renovation",
      "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
      "extract": [
        {
          "key": "budget",
          "type": "money",
          "description": "Project budget"
        },
        {
          "key": "start_date",
          "type": "date",
          "description": "When the customer wants work to start"
        }
      ],
      "dimensions": [
        {
          "id": "what",
          "label": "What"
        },
        {
          "id": "when",
          "label": "When"
        }
      ],
      "criteria": [
        {
          "id": "budget_15k",
          "label": "Budget from $15k",
          "dimension": "what",
          "type": "rule",
          "condition": {
            "field": "fields.budget",
            "op": "gte",
            "value": 15000
          },
          "points": 30
        },
        {
          "id": "big_project",
          "label": "Kitchen, full home or extension",
          "dimension": "what",
          "type": "rule",
          "condition": {
            "field": "fields.project_type",
            "op": "in",
            "value": [
              "kitchen",
              "full_home"
            ]
          },
          "points": 20
        }
      ],
      "scoring": {
        "method": "sum",
        "maxGrade": 5
      },
      "tiers": [
        {
          "name": "hot",
          "minScore": 70
        },
        {
          "name": "warm",
          "minScore": 40
        }
      ],
      "junk": {
        "enabled": true,
        "extraRules": [
          "Offers of SEO, marketing or lead generation services are junk"
        ],
        "blockDomains": [],
        "allowDomains": []
      }
    },
    "draft": null,
    "createdAt": "2026-10-23T14:51:55.675Z",
    "updatedAt": "2026-10-23T14:51:55.684Z"
  },
  "assumptions": [
    "assumptions"
  ],
  "dropped": [
    "dropped"
  ],
  "usage": {
    "costUsd": 0,
    "inputTokens": 0,
    "outputTokens": 0,
    "models": [
      "models"
    ]
  }
}

GET/v1/profiles/{id}

Get a profile with its active version and draft

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

GET
/v1/profiles/{id}
curl https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

DELETE/v1/profiles/{id}

Delete a profile (published versions are kept for past evaluations)

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

DELETE
/v1/profiles/{id}
curl -X DELETE https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "profile",
  "id": "id",
  "deleted": true
}

PUT/v1/profiles/{id}/draft

Replace the draft with a full document

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

PUT
/v1/profiles/{id}/draft
curl -X PUT https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/draft \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{}'

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

PATCH/v1/profiles/{id}/draft

Edit the draft: set top-level parts, upsert/remove fields and criteria

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Optional attributes

  • Name
    set
    Type
    object
    Description

    Replace top-level parts: name, brief, scoring, tiers, junk

  • Name
    upsertFields
    Type
    array of object
    Description

    Add or replace extract fields by key

  • Name
    removeFields
    Type
    array of string
    Description

     

  • Name
    upsertCriteria
    Type
    array of object
    Description

    Add or replace criteria by id

  • Name
    removeCriteria
    Type
    array of string
    Description

     

Request

PATCH
/v1/profiles/{id}/draft
curl -X PATCH https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/draft \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{
    "set": {
      "tiers": [
        {
          "name": "hot",
          "minScore": 75
        },
        {
          "name": "warm",
          "minScore": 45
        }
      ]
    },
    "upsertCriteria": [
      {
        "id": "big_budget",
        "type": "rule",
        "label": "Budget 20k+",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 20000
        },
        "points": 30
      }
    ],
    "removeCriteria": [
      "old_rule"
    ]
  }'

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

DELETE/v1/profiles/{id}/draft

Discard the draft

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

DELETE
/v1/profiles/{id}/draft
curl -X DELETE https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/draft \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

POST/v1/profiles/{id}/publish

Publish the draft as a new active version

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

POST
/v1/profiles/{id}/publish
curl -X POST https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/publish \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

POST/v1/profiles/{id}/activate

Make a published version active (rollback)

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Required attributes

  • Name
    version
    Type
    integer
    Description

     

Request

POST
/v1/profiles/{id}/activate
curl -X POST https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/activate \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only \
  -H "Content-Type: application/json" \
  -d '{
    "version": 0
  }'

Response 200

{
  "object": "profile",
  "id": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "name": "Home renovation",
  "isDefault": true,
  "activeVersion": 1,
  "latestVersion": 1,
  "document": {
    "schemaVersion": "2026-10",
    "name": "Home renovation",
    "brief": "Residential renovation company: kitchens, bathrooms, full-home renovations and extensions. Best customers are home owners with a budget from $15,000 who want to…",
    "extract": [
      {
        "key": "budget",
        "type": "money",
        "description": "Project budget"
      },
      {
        "key": "start_date",
        "type": "date",
        "description": "When the customer wants work to start"
      }
    ],
    "dimensions": [
      {
        "id": "what",
        "label": "What"
      },
      {
        "id": "when",
        "label": "When"
      }
    ],
    "criteria": [
      {
        "id": "budget_15k",
        "label": "Budget from $15k",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.budget",
          "op": "gte",
          "value": 15000
        },
        "points": 30
      },
      {
        "id": "big_project",
        "label": "Kitchen, full home or extension",
        "dimension": "what",
        "type": "rule",
        "condition": {
          "field": "fields.project_type",
          "op": "in",
          "value": [
            "kitchen",
            "full_home"
          ]
        },
        "points": 20
      }
    ],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [
        "Offers of SEO, marketing or lead generation services are junk"
      ],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "draft": null,
  "createdAt": "2026-10-23T14:51:55.675Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

GET/v1/profiles/{id}/versions

Published versions, newest first

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Query parameters

  • Name
    limit
    Type
    integer
    Description

    1–100, default 20

  • Name
    starting_after
    Type
    string
    Description

    ID of the last item of the previous page

Request

GET
/v1/profiles/{id}/versions
curl https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/versions \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "list",
  "data": [
    {
      "object": "profile_version",
      "id": "id",
      "profileId": "prof_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
      "version": 0,
      "document": {
        "schemaVersion": "2026-10",
        "name": "name",
        "brief": "",
        "extract": [],
        "dimensions": [],
        "criteria": [],
        "scoring": {
          "method": "sum",
          "maxGrade": 5
        },
        "tiers": [
          {
            "name": "hot",
            "minScore": 70
          },
          {
            "name": "warm",
            "minScore": 40
          }
        ],
        "junk": {
          "enabled": true,
          "extraRules": [],
          "blockDomains": [],
          "allowDomains": []
        }
      },
      "publishedAt": "2026-11-02T09:30:00.000Z",
      "publishedBy": {
        "type": "user",
        "id": "id"
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/v1/profiles/{id}/versions/{version}

One published version

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

  • Name
    version
    Type
    integer
    Description

     

Request

GET
/v1/profiles/{id}/versions/{version}
curl https://core.leadveyor.com/v1/profiles/prof_7Kd2Rm9QxV4Lp1Zt8Nc3Hy6b/versions/1 \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "profile_version",
  "id": "id",
  "profileId": "prof_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
  "version": 0,
  "document": {
    "schemaVersion": "2026-10",
    "name": "name",
    "brief": "",
    "extract": [],
    "dimensions": [],
    "criteria": [],
    "scoring": {
      "method": "sum",
      "maxGrade": 5
    },
    "tiers": [
      {
        "name": "hot",
        "minScore": 70
      },
      {
        "name": "warm",
        "minScore": 40
      }
    ],
    "junk": {
      "enabled": true,
      "extraRules": [],
      "blockDomains": [],
      "allowDomains": []
    }
  },
  "publishedAt": "2026-11-02T09:30:00.000Z",
  "publishedBy": {
    "type": "user",
    "id": "id"
  }
}

Was this page helpful?