#The Visitor object

Captures the cross-link profile Linkbreakers builds for someone who scans or clicks, combining reserved identity fields, attributed devices, events, and custom traits gathered from forms.

attributes

array<object>

Arbitrary attributes provided without "$" prefix, with the type each value was captured as.

createdAt

string (date-time)

Timestamps

deviceCount

string (int64)

Number of devices attributed to this visitor

devices

array<object>

Device information collected during visitor interactions

string

from "$email"

events

array<object>

Events associated with this visitor

firstName

string

from "$firstName" (optional)

string

Unique ID (UUID)

lastName

string

from "$lastName" (optional)

links

array<object>

Links associated with this visitor via events (included only on demand)

phone

string

from "$phone"

qrcodeCount

string (int64)

Number of distinct QR codes / links this visitor has interacted with

updatedAt

string (date-time)

visitCount

string (int64)

Total number of events (visits) recorded for this visitor

workspaceId

string

Workspace that owns this visitor (UUID)

Learn more

Learn more about visitor profiles in Linkbreakers.

Example object

{
  "attributes": [
    {
      "boolValue": false,
      "dateValue": "2026-10-05T03:42:29.673Z",
      "key": "rating",
      "numberValue": 0,
      "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED",
      "value": "8"
    }
  ],
  "createdAt": "2026-10-05T03:42:29.673Z",
  "deviceCount": 2,
  "devices": [
    {
      "asn": 7922,
      "browserLanguage": "en-US,en;q=0.9",
      "browserName": "Chrome",
      "browserVersion": "99.0.4844.51",
      "city": "New York",
      "country": "US",
      "createdAt": "2026-10-05T03:42:29.673Z",
      "deviceActor": "DEVICE_ACTOR_HUMAN",
      "deviceActorName": "GPTBot",
      "deviceActorOrigin": "OpenAI",
      "deviceBrand": "Apple",
      "deviceConcurrency": 4,
      "deviceMemory": 6,
      "deviceName": "iPhone 14 Pro",
      "deviceType": "DEVICE_TYPE_MOBILE",
      "gpu": "Apple GPU",
      "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
      "ipAddress": "203.0.113.42",
      "isp": "Comcast Cable Communications",
      "lastUsedAt": "2026-10-05T03:42:29.673Z",
      "networkBandwidth": 10,
      "networkConnection": "4g",
      "networkRtt": 50,
      "platformName": "macOS",
      "platformVersion": "10.15.7",
      "region": "CRF",
      "screenHeight": 1117,
      "screenRatio": 1.55,
      "screenWidth": 1728,
      "state": "NY",
      "timezone": "Europe/London",
      "touchScreen": true,
      "updatedAt": "2026-10-05T03:42:29.673Z",
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
    }
  ],
  "email": "[email protected]",
  "events": [
    {
      "action": "SCAN",
      "createdAt": "2026-10-05T03:42:29.673Z",
      "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "scannedAt": "2026-10-05T03:42:29.673Z",
      "visitType": "FIRST"
    }
  ],
  "firstName": "Sam",
  "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
  "lastName": "Rivera",
  "links": [
    {
      "entrypoint": "https://linkbreak.ing/4BnH-R19p",
      "eventCount": 12,
      "firstVisitedAt": "2026-10-05T03:42:29.673Z",
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "lastVisitedAt": "2026-10-05T03:42:29.673Z",
      "name": "Spring Launch Campaign",
      "shortlink": "4BnH-R19p"
    }
  ],
  "phone": "+15551234567",
  "qrcodeCount": 3,
  "updatedAt": "2026-10-05T03:42:29.673Z",
  "visitCount": 42,
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET

/v1/visitors

Requires auth

#List visitors

Returns a paginated collection of visitors with optional filters, includes, and CSV export. To filter on visitor attributes, use POST /v1/visitors/search, which takes the same parameters as a JSON body.

#Parameters

query parameters

pageSize

integer (int64)

query

Maximum number of visitors to return (default 50, max 200)

pageToken

string

query

Cursor token to retrieve the next page of results

string

query

optional exact match filter

string

query

optional fuzzy search across known fields

include

array<string>

query

linkId

string

query

optional filter by link ID (UUID; visitors who have interacted with this link)

responseFormat

string

query

- RESPONSE_FORMAT_UNSPECIFIED: Response format not specified - RESPONSE_FORMAT_JSON: Response format JSON - RESPONSE_FORMAT_CSV: Response format CSV

Allowed values

RESPONSE_FORMAT_UNSPECIFIED

Response format not specified

RESPONSE_FORMAT_JSON

Response format JSON

RESPONSE_FORMAT_CSV

Response format CSV

sortField

string

query

Field to sort by. Defaults to created_at (newest first).

Allowed values

VISITOR_SORT_FIELD_UNSPECIFIED

Sort field not specified (defaults to created_at)

VISITOR_SORT_FIELD_CREATED_AT

Sort by the date the visitor was first seen

VISITOR_SORT_FIELD_VISIT_COUNT

Sort by total number of visits (events)

VISITOR_SORT_FIELD_DEVICE_COUNT

Sort by number of attributed devices

VISITOR_SORT_FIELD_QRCODE_COUNT

Sort by number of distinct QR codes interacted with

sortDirection

string

query

Sort direction. Defaults to descending.

Allowed values

SORT_DIRECTION_UNSPECIFIED

Sort direction not specified (defaults to descending)

SORT_DIRECTION_ASC

Sort in ascending order

SORT_DIRECTION_DESC

Sort in descending order

#Response

200

Everything worked as expected.

csv

object

ListVisitorsCsvResponse carries the raw CSV when ResponseFormat is set to RESPONSE_FORMAT_CSV.

json

object

ListVisitorsJsonResponse is the default structured payload used by dashboards.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/visitors?pageSize={pageSize}&pageToken={pageToken}&email={email}&search={search}&include={include}&linkId={linkId}&responseFormat={responseFormat}&sortField={sortField}&sortDirection={sortDirection}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "csv": {
    "contentType": "string",
    "csvData": "string"
  },
  "json": {
    "hasMore": false,
    "nextPageToken": "eyJ2aXNpdG9ySWQiOiI0ZGEzIn0=",
    "totalCount": 128,
    "visitors": [
      {
        "attributes": [],
        "createdAt": "2026-10-05T03:42:29.671Z",
        "deviceCount": 2,
        "devices": [],
        "email": "[email protected]",
        "events": [],
        "firstName": "Sam",
        "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
        "lastName": "Rivera",
        "links": [],
        "phone": "+15551234567",
        "qrcodeCount": 3,
        "updatedAt": "2026-10-05T03:42:29.671Z",
        "visitCount": 42,
        "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
      }
    ]
  }
}

Base URL: https://api.linkbreakers.com

GET

/v1/visitors/{id}

Requires auth

#Get a visitor

Retrieves a visitor profile by ID with optional devices, events, or links included.

#Parameters

path parameters

string

Required

path

Visitor identifier (UUID)

query parameters

include

array<string>

query

Optional relationships to hydrate ("devices", "events", "links")

#Response

200

Everything worked as expected.

attributes

array<object>

Arbitrary attributes provided without "$" prefix, with the type each value was captured as.

createdAt

string (date-time)

Timestamps

deviceCount

string (int64)

Number of devices attributed to this visitor

devices

array<object>

Device information collected during visitor interactions

string

from "$email"

events

array<object>

Events associated with this visitor

firstName

string

from "$firstName" (optional)

string

Unique ID (UUID)

lastName

string

from "$lastName" (optional)

links

array<object>

Links associated with this visitor via events (included only on demand)

phone

string

from "$phone"

qrcodeCount

string (int64)

Number of distinct QR codes / links this visitor has interacted with

updatedAt

string (date-time)

visitCount

string (int64)

Total number of events (visits) recorded for this visitor

workspaceId

string

Workspace that owns this visitor (UUID)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/visitors/{id}?include={include}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "attributes": [
    {
      "boolValue": false,
      "dateValue": "2026-10-05T03:42:29.672Z",
      "key": "rating",
      "numberValue": 0,
      "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED",
      "value": "8"
    }
  ],
  "createdAt": "2026-10-05T03:42:29.672Z",
  "deviceCount": 2,
  "devices": [
    {
      "asn": 7922,
      "browserLanguage": "en-US,en;q=0.9",
      "browserName": "Chrome",
      "browserVersion": "99.0.4844.51",
      "city": "New York",
      "country": "US",
      "createdAt": "2026-10-05T03:42:29.672Z",
      "deviceActor": "DEVICE_ACTOR_HUMAN",
      "deviceActorName": "GPTBot",
      "deviceActorOrigin": "OpenAI",
      "deviceBrand": "Apple",
      "deviceConcurrency": 4,
      "deviceMemory": 6,
      "deviceName": "iPhone 14 Pro",
      "deviceType": "DEVICE_TYPE_MOBILE",
      "gpu": "Apple GPU",
      "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
      "ipAddress": "203.0.113.42",
      "isp": "Comcast Cable Communications",
      "lastUsedAt": "2026-10-05T03:42:29.672Z",
      "networkBandwidth": 10,
      "networkConnection": "4g",
      "networkRtt": 50,
      "platformName": "macOS",
      "platformVersion": "10.15.7",
      "region": "CRF",
      "screenHeight": 1117,
      "screenRatio": 1.55,
      "screenWidth": 1728,
      "state": "NY",
      "timezone": "Europe/London",
      "touchScreen": true,
      "updatedAt": "2026-10-05T03:42:29.672Z",
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
    }
  ],
  "email": "[email protected]",
  "events": [
    {
      "action": "SCAN",
      "createdAt": "2026-10-05T03:42:29.672Z",
      "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "scannedAt": "2026-10-05T03:42:29.672Z",
      "visitType": "FIRST"
    }
  ],
  "firstName": "Sam",
  "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
  "lastName": "Rivera",
  "links": [
    {
      "entrypoint": "https://linkbreak.ing/4BnH-R19p",
      "eventCount": 12,
      "firstVisitedAt": "2026-10-05T03:42:29.672Z",
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "lastVisitedAt": "2026-10-05T03:42:29.672Z",
      "name": "Spring Launch Campaign",
      "shortlink": "4BnH-R19p"
    }
  ],
  "phone": "+15551234567",
  "qrcodeCount": 3,
  "updatedAt": "2026-10-05T03:42:29.672Z",
  "visitCount": 42,
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

GET

/v1/visitors/attributes

Requires auth

#List visitor attribute keys

Returns the distinct visitor attribute keys available in the workspace or scoped to a single link.

#Parameters

query parameters

linkId

string

query

Optional link identifier (UUID). When set, returns keys observed on visitors who interacted with this link.

#Response

200

Everything worked as expected.

attributeKeys

array<string>

Distinct selectable visitor attribute keys, including reserved system fields such as $email and $phone.

attributes

array<object>

The same keys with the type their values were captured as, so a client can offer the filter operators that fit each one.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/visitors/attributes?linkId={linkId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "attributeKeys": [
    "$email",
    "$phone",
    "$firstName",
    "$lastName",
    "company",
    "plan"
  ],
  "attributes": [
    {
      "key": "budget",
      "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED"
    }
  ]
}

Base URL: https://api.linkbreakers.com

POST

/v1/visitor/identify

Requires auth

#Identify visitor

Identifies a visitor from an LBID. Anonymous visitors (created at scan time) are promoted or merged into existing identified visitors. If the identity matches an existing visitor, devices and events converge into that source-of-truth record.

#Parameters

This endpoint does not accept any parameters.

#Request body

lbid

string

LBID (base64 encoded event ID) that initiated the visit (click/scan)

setOnce

boolean

If true, only set fields that are empty (set-once semantics); defaults to false (merge/overwrite)

visitor

object

Input payload for identifying/updating a visitor - Reserved keys (system fields) have a "$" prefix, e.g. "$email", "$phone", "$firstName", "$lastName". - All other keys are treated as custom attributes and stored in `attributes`.

#Response

200

Everything worked as expected.

created

boolean

Indicates whether a new visitor profile was created as part of the identification

visitor

object

Captures the cross-link profile Linkbreakers builds for someone who scans or clicks, combining reserved identity fields, attributed devices, events, and custom traits gathered from forms.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/visitor/identify" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"lbid":"string","setOnce":false,"visitor":{"data":{}}}'

Sample payload (application/json)

{
  "lbid": "string",
  "setOnce": false,
  "visitor": {
    "data": {}
  }
}

Typical response

{
  "created": false,
  "visitor": {
    "attributes": [
      {
        "boolValue": false,
        "dateValue": "2026-10-05T03:42:29.671Z",
        "key": "rating",
        "numberValue": 0,
        "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED",
        "value": "8"
      }
    ],
    "createdAt": "2026-10-05T03:42:29.671Z",
    "deviceCount": 2,
    "devices": [
      {
        "asn": 7922,
        "browserLanguage": "en-US,en;q=0.9",
        "browserName": "Chrome",
        "browserVersion": "99.0.4844.51",
        "city": "New York",
        "country": "US",
        "createdAt": "2026-10-05T03:42:29.671Z",
        "deviceActor": "DEVICE_ACTOR_HUMAN",
        "deviceActorName": "GPTBot",
        "deviceActorOrigin": "OpenAI",
        "deviceBrand": "Apple",
        "deviceConcurrency": 4,
        "deviceMemory": 6,
        "deviceName": "iPhone 14 Pro",
        "deviceType": "DEVICE_TYPE_MOBILE",
        "gpu": "Apple GPU",
        "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
        "ipAddress": "203.0.113.42",
        "isp": "Comcast Cable Communications",
        "lastUsedAt": "2026-10-05T03:42:29.671Z",
        "networkBandwidth": 10,
        "networkConnection": "4g",
        "networkRtt": 50,
        "platformName": "macOS",
        "platformVersion": "10.15.7",
        "region": "CRF",
        "screenHeight": 1117,
        "screenRatio": 1.55,
        "screenWidth": 1728,
        "state": "NY",
        "timezone": "Europe/London",
        "touchScreen": true,
        "updatedAt": "2026-10-05T03:42:29.671Z",
        "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
      }
    ],
    "email": "[email protected]",
    "events": [
      {
        "action": "SCAN",
        "createdAt": "2026-10-05T03:42:29.671Z",
        "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
        "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "scannedAt": "2026-10-05T03:42:29.671Z",
        "visitType": "FIRST"
      }
    ],
    "firstName": "Sam",
    "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
    "lastName": "Rivera",
    "links": [
      {
        "entrypoint": "https://linkbreak.ing/4BnH-R19p",
        "eventCount": 12,
        "firstVisitedAt": "2026-10-05T03:42:29.671Z",
        "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "lastVisitedAt": "2026-10-05T03:42:29.671Z",
        "name": "Spring Launch Campaign",
        "shortlink": "4BnH-R19p"
      }
    ],
    "phone": "+15551234567",
    "qrcodeCount": 3,
    "updatedAt": "2026-10-05T03:42:29.671Z",
    "visitCount": 42,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

POST

/v1/visitors/search

Requires auth

#Search visitors

Same as List visitors, with the parameters sent as a JSON body so they can include attributeFilters. Every filter must match, for example budget at least 800000 and timeline equal to under_6_months.

#Parameters

This endpoint does not accept any parameters.

#Request body

attributeFilters

array<object>

Only return visitors matching every filter, for example budget >= 800000 and timeline = "under_6_months". At most 20. Over REST, use POST /v1/visitors/search: a query string cannot carry them.

string

optional exact match filter

include

array<string>

linkId

string

optional filter by link ID (UUID; visitors who have interacted with this link)

pageSize

integer (int64)

Maximum number of visitors to return (default 50, max 200)

pageToken

string

Cursor token to retrieve the next page of results

responseFormat

string (enum)

ResponseFormat defines the transport format the API should return for list-style endpoints.

Allowed values

RESPONSE_FORMAT_UNSPECIFIED

Response format not specified

RESPONSE_FORMAT_JSON

Response format JSON

RESPONSE_FORMAT_CSV

Response format CSV

string

optional fuzzy search across known fields

sortDirection

string (enum)

SortDirection is the ordering applied to any sortable list endpoint. Shared across resources so a caller learns it once.

Allowed values

SORT_DIRECTION_UNSPECIFIED

Sort direction not specified (defaults to descending)

SORT_DIRECTION_ASC

Sort in ascending order

SORT_DIRECTION_DESC

Sort in descending order

sortField

string (enum)

Fields that can be used to sort visitors

Allowed values

VISITOR_SORT_FIELD_UNSPECIFIED

Sort field not specified (defaults to created_at)

VISITOR_SORT_FIELD_CREATED_AT

Sort by the date the visitor was first seen

VISITOR_SORT_FIELD_VISIT_COUNT

Sort by total number of visits (events)

VISITOR_SORT_FIELD_DEVICE_COUNT

Sort by number of attributed devices

VISITOR_SORT_FIELD_QRCODE_COUNT

Sort by number of distinct QR codes interacted with

#Response

200

Everything worked as expected.

csv

object

ListVisitorsCsvResponse carries the raw CSV when ResponseFormat is set to RESPONSE_FORMAT_CSV.

json

object

ListVisitorsJsonResponse is the default structured payload used by dashboards.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/visitors/search" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"attributeFilters":[{"key":"budget","operator":"VISITOR_ATTRIBUTE_FILTER_OPERATOR_NUMBER_GREATER_OR_EQUAL","value":"800000"}],"email":"string","include":["devices","events","links"],"linkId":"1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed","pageSize":0,"pageToken":"string","responseFormat":"RESPONSE_FORMAT_JSON","search":"string","sortDirection":"SORT_DIRECTION_DESC","sortField":"VISITOR_SORT_FIELD_VISIT_COUNT"}'

Sample payload (application/json)

{
  "attributeFilters": [
    {
      "key": "budget",
      "operator": "VISITOR_ATTRIBUTE_FILTER_OPERATOR_NUMBER_GREATER_OR_EQUAL",
      "value": "800000"
    }
  ],
  "email": "string",
  "include": [
    "devices",
    "events",
    "links"
  ],
  "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "pageSize": 0,
  "pageToken": "string",
  "responseFormat": "RESPONSE_FORMAT_JSON",
  "search": "string",
  "sortDirection": "SORT_DIRECTION_DESC",
  "sortField": "VISITOR_SORT_FIELD_VISIT_COUNT"
}

Typical response

{
  "csv": {
    "contentType": "string",
    "csvData": "string"
  },
  "json": {
    "hasMore": false,
    "nextPageToken": "eyJ2aXNpdG9ySWQiOiI0ZGEzIn0=",
    "totalCount": 128,
    "visitors": [
      {
        "attributes": [],
        "createdAt": "2026-10-05T03:42:29.672Z",
        "deviceCount": 2,
        "devices": [],
        "email": "[email protected]",
        "events": [],
        "firstName": "Sam",
        "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
        "lastName": "Rivera",
        "links": [],
        "phone": "+15551234567",
        "qrcodeCount": 3,
        "updatedAt": "2026-10-05T03:42:29.672Z",
        "visitCount": 42,
        "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
      }
    ]
  }
}

Base URL: https://api.linkbreakers.com

PATCH

/v1/visitors/{id}

Requires auth

#Update a visitor

Applies partial attribute updates to an existing visitor profile.

#Parameters

path parameters

string

Required

path

Visitor identifier (UUID)

#Request body

visitor

object

#Response

200

Everything worked as expected.

attributes

array<object>

Arbitrary attributes provided without "$" prefix, with the type each value was captured as.

createdAt

string (date-time)

Timestamps

deviceCount

string (int64)

Number of devices attributed to this visitor

devices

array<object>

Device information collected during visitor interactions

string

from "$email"

events

array<object>

Events associated with this visitor

firstName

string

from "$firstName" (optional)

string

Unique ID (UUID)

lastName

string

from "$lastName" (optional)

links

array<object>

Links associated with this visitor via events (included only on demand)

phone

string

from "$phone"

qrcodeCount

string (int64)

Number of distinct QR codes / links this visitor has interacted with

updatedAt

string (date-time)

visitCount

string (int64)

Total number of events (visits) recorded for this visitor

workspaceId

string

Workspace that owns this visitor (UUID)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/visitors/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"visitor":{"data":{}}}'

Sample payload (application/json)

{
  "visitor": {
    "data": {}
  }
}

Typical response

{
  "attributes": [
    {
      "boolValue": false,
      "dateValue": "2026-10-05T03:42:29.672Z",
      "key": "rating",
      "numberValue": 0,
      "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED",
      "value": "8"
    }
  ],
  "createdAt": "2026-10-05T03:42:29.672Z",
  "deviceCount": 2,
  "devices": [
    {
      "asn": 7922,
      "browserLanguage": "en-US,en;q=0.9",
      "browserName": "Chrome",
      "browserVersion": "99.0.4844.51",
      "city": "New York",
      "country": "US",
      "createdAt": "2026-10-05T03:42:29.672Z",
      "deviceActor": "DEVICE_ACTOR_HUMAN",
      "deviceActorName": "GPTBot",
      "deviceActorOrigin": "OpenAI",
      "deviceBrand": "Apple",
      "deviceConcurrency": 4,
      "deviceMemory": 6,
      "deviceName": "iPhone 14 Pro",
      "deviceType": "DEVICE_TYPE_MOBILE",
      "gpu": "Apple GPU",
      "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
      "ipAddress": "203.0.113.42",
      "isp": "Comcast Cable Communications",
      "lastUsedAt": "2026-10-05T03:42:29.672Z",
      "networkBandwidth": 10,
      "networkConnection": "4g",
      "networkRtt": 50,
      "platformName": "macOS",
      "platformVersion": "10.15.7",
      "region": "CRF",
      "screenHeight": 1117,
      "screenRatio": 1.55,
      "screenWidth": 1728,
      "state": "NY",
      "timezone": "Europe/London",
      "touchScreen": true,
      "updatedAt": "2026-10-05T03:42:29.672Z",
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
    }
  ],
  "email": "[email protected]",
  "events": [
    {
      "action": "SCAN",
      "createdAt": "2026-10-05T03:42:29.672Z",
      "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "scannedAt": "2026-10-05T03:42:29.672Z",
      "visitType": "FIRST"
    }
  ],
  "firstName": "Sam",
  "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
  "lastName": "Rivera",
  "links": [
    {
      "entrypoint": "https://linkbreak.ing/4BnH-R19p",
      "eventCount": 12,
      "firstVisitedAt": "2026-10-05T03:42:29.672Z",
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "lastVisitedAt": "2026-10-05T03:42:29.672Z",
      "name": "Spring Launch Campaign",
      "shortlink": "4BnH-R19p"
    }
  ],
  "phone": "+15551234567",
  "qrcodeCount": 3,
  "updatedAt": "2026-10-05T03:42:29.672Z",
  "visitCount": 42,
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

DELETE

/v1/visitors/{id}

Requires auth

#Delete a visitor

Removes a visitor profile and its stored attributes from the workspace.

#Parameters

path parameters

string

Required

path

Visitor identifier to remove (UUID)

#Response

200

Everything worked as expected.

success

boolean

Indicates whether the visitor record was deleted

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X DELETE "https://api.linkbreakers.com/v1/visitors/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "success": false
}

Base URL: https://api.linkbreakers.com

DELETE

/v1/visitors/{id}/attributes/{attributeKey}

Requires auth

#Delete a visitor attribute

Deletes a single attribute from the visitor profile without affecting other data.

#Parameters

path parameters

string

Required

path

Visitor identifier whose attribute should be removed (UUID)

attributeKey

string

Required

path

Attribute key to delete (without "$" prefix)

#Response

200

Everything worked as expected.

success

boolean

Indicates whether the attribute was removed

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X DELETE "https://api.linkbreakers.com/v1/visitors/{id}/attributes/{attributeKey}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "success": false
}

Base URL: https://api.linkbreakers.com