Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range.

GET/api/visitors

Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range. When both page and offset are sent, page takes precedence. Use the returned pagination metadata rather than inferring another page from the item count. Filters and search are evaluated only against visitors in the authenticated organization.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: visitors:read
Module: Automation & API module (automation_api)
Organization and site scope: Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior: Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

page?integer

One-based page number.

offset?integer

Zero-based number of resources to skip.

search?string

Query parameter. Search text.

status?string

Query parameter. Status. Allowed values: online, offline.

tags?array<>

Query parameter. Tags assigned to this resource.

blocked?string

Query parameter. Value of blocked.

minVisits?integer

Query parameter. Value of minVisits.

maxVisits?integer

Query parameter. Value of maxVisits.

lastSeenFrom?string

Query parameter. ISO 8601 date and time for lastSeenFrom.

lastSeenTo?string

Query parameter. ISO 8601 date and time for lastSeenTo.

Response Body

`application/json`

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "orgId": "770e8400-e29b-41d4-a716-446655440000",
      "identifier": "[email protected]",
      "publicCode": "example",
      "identitySource": "anonymous",
      "identityVerifiedAt": "2026-08-04T10:00:00.000Z",
      "fingerprint": "fp_123",
      "firstSeenAt": "2026-06-20T08:00:00.000Z",
      "lastSeenAt": "2026-06-23T08:00:00.000Z",
      "totalSessions": 5,
      "geoCountry": "US",
      "geoCity": "New York",
      "metadata": {},
      "browser": {
        "name": "Chrome",
        "version": "126.0",
        "userAgent": "example",
        "isMobile": true,
        "isTablet": true,
        "isDesktop": true,
        "os": "macOS",
        "osVersion": "example"
      },
      "lastPage": "https://customer.example.org/pricing",
      "isReturning": true,
      "name": "Example name",
      "email": "[email protected]",
      "phone": "+48123456789",
      "tags": [],
      "blocked": false,
      "conversationCount": 0,
      "isActive": true,
      "totalTimeOnSiteSeconds": 0
    }
  ],
  "pagination": {
    "totalItems": 1,
    "page": 1,
    "pageSize": 20,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

List visitors

Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range.

GET/api/visitors

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: visitors:read
Module: Automation & API module (automation_api)
Organization and site scope: Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior: Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

page?integer

One-based page number.

offset?integer

Zero-based number of resources to skip.

search?string

Query parameter. Search text.

status?string

Query parameter. Status. Allowed values: online, offline.

tags?array<>

Query parameter. Tags assigned to this resource.

blocked?string

Query parameter. Value of blocked.

minVisits?integer

Query parameter. Value of minVisits.

maxVisits?integer

Query parameter. Value of maxVisits.

lastSeenFrom?string

Query parameter. ISO 8601 date and time for lastSeenFrom.

lastSeenTo?string

Query parameter. ISO 8601 date and time for lastSeenTo.

Response Body

`application/json`

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "orgId": "770e8400-e29b-41d4-a716-446655440000",
      "identifier": "[email protected]",
      "publicCode": "example",
      "identitySource": "anonymous",
      "identityVerifiedAt": "2026-08-04T10:00:00.000Z",
      "fingerprint": "fp_123",
      "firstSeenAt": "2026-06-20T08:00:00.000Z",
      "lastSeenAt": "2026-06-23T08:00:00.000Z",
      "totalSessions": 5,
      "geoCountry": "US",
      "geoCity": "New York",
      "metadata": {},
      "browser": {
        "name": "Chrome",
        "version": "126.0",
        "userAgent": "example",
        "isMobile": true,
        "isTablet": true,
        "isDesktop": true,
        "os": "macOS",
        "osVersion": "example"
      },
      "lastPage": "https://customer.example.org/pricing",
      "isReturning": true,
      "name": "Example name",
      "email": "[email protected]",
      "phone": "+48123456789",
      "tags": [],
      "blocked": false,
      "conversationCount": 0,
      "isActive": true,
      "totalTimeOnSiteSeconds": 0
    }
  ],
  "pagination": {
    "totalItems": 1,
    "page": 1,
    "pageSize": 20,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

List visitors

Endpoint requirements

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

List visitors

Endpoint requirements

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

List visitors

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

List visitors

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`