Workspaces

A workspace is one business with its own data: profiles, sources, leads and webhooks. Its settings (business description, address, timezone, currency, business hours) are used when scoring.

The Workspace object

Properties

  • Name
    object
    Type
    'workspace'
    Description

    The object type.

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

  • Name
    accountId
    Type
    string
    Description

    The account this object belongs to.

  • Name
    name
    Type
    string
    Description

    Display name.

  • Name
    businessContext
    Type
    string or null
    Description

     

  • Name
    location
    Type
    object or null
    Description

    Where: address, city, postcode, country; with coordinates, distance (km) and drive time (minutes) from the business when known.

  • Name
    locale
    Type
    object
    Description

     

  • Name
    businessHours
    Type
    object or null
    Description

     

  • Name
    defaultProfileId
    Type
    string or null
    Description

     

  • Name
    retentionDays
    Type
    integer
    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/workspaces

List workspaces the caller can access

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/workspaces
curl https://core.leadveyor.com/v1/workspaces \
  -H "Authorization: Bearer {api_key}"

Response 200

{
  "object": "list",
  "data": [
    {
      "object": "workspace",
      "id": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
      "accountId": "acc_mZp0zVZomHFwUbbYrEqmSM9w",
      "name": "Acme Renovations",
      "businessContext": null,
      "location": null,
      "locale": {
        "language": "en",
        "timezone": "UTC",
        "currency": "USD"
      },
      "businessHours": null,
      "defaultProfileId": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
      "retentionDays": 90,
      "createdAt": "2026-10-23T14:51:53.415Z",
      "updatedAt": "2026-10-23T14:51:55.684Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

POST/v1/workspaces

Create a workspace (admin, account-wide access)

Required attributes

  • Name
    name
    Type
    string
    Description

    Display name.

Optional attributes

  • Name
    businessContext
    Type
    string or null
    Description

    What the business does, its services and area. Used by AI for every profile.

  • Name
    location
    Type
    object or null
    Description

    Business address. Send only the address and Leadveyor finds the coordinates (and tidies the address).

  • Name
    locale
    Type
    object
    Description

     

  • Name
    businessHours
    Type
    object or null
    Description

     

  • Name
    retentionDays
    Type
    integer
    Description

     

Request

POST
/v1/workspaces
curl -X POST https://core.leadveyor.com/v1/workspaces \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "name",
    "businessContext": null,
    "location": {
      "address": "address",
      "lat": 0,
      "lng": 0
    },
    "locale": {
      "language": "language",
      "timezone": "timezone",
      "currency": "currency"
    }
  }'

Response 201

{
  "object": "workspace",
  "id": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "accountId": "acc_mZp0zVZomHFwUbbYrEqmSM9w",
  "name": "Acme Renovations",
  "businessContext": null,
  "location": null,
  "locale": {
    "language": "en",
    "timezone": "UTC",
    "currency": "USD"
  },
  "businessHours": null,
  "defaultProfileId": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "retentionDays": 90,
  "createdAt": "2026-10-23T14:51:53.415Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

GET/v1/workspaces/{id}

Get a workspace

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Request

GET
/v1/workspaces/{id}
curl https://core.leadveyor.com/v1/workspaces/ws_1Bq7Xn4KpRz9Lc2Vt6Hy0Mde \
  -H "Authorization: Bearer {api_key}"

Response 200

{
  "object": "workspace",
  "id": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "accountId": "acc_mZp0zVZomHFwUbbYrEqmSM9w",
  "name": "Acme Renovations",
  "businessContext": null,
  "location": null,
  "locale": {
    "language": "en",
    "timezone": "UTC",
    "currency": "USD"
  },
  "businessHours": null,
  "defaultProfileId": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "retentionDays": 90,
  "createdAt": "2026-10-23T14:51:53.415Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

PATCH/v1/workspaces/{id}

Update a workspace (admin)

Path parameters

  • Name
    id
    Type
    string
    Description

    Unique identifier, prefixed by the object type.

Optional attributes

  • Name
    name
    Type
    string
    Description

    Display name.

  • Name
    businessContext
    Type
    string or null
    Description

    What the business does, its services and area. Used by AI for every profile.

  • Name
    location
    Type
    object or null
    Description

    Business address. Send only the address and Leadveyor finds the coordinates (and tidies the address).

  • Name
    locale
    Type
    object
    Description

     

  • Name
    businessHours
    Type
    object or null
    Description

     

  • Name
    retentionDays
    Type
    integer
    Description

     

  • Name
    defaultProfileId
    Type
    string or null
    Description

    A published profile of this workspace

Request

PATCH
/v1/workspaces/{id}
curl -X PATCH https://core.leadveyor.com/v1/workspaces/ws_1Bq7Xn4KpRz9Lc2Vt6Hy0Mde \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "name",
    "businessContext": null,
    "location": {
      "address": "address",
      "lat": 0,
      "lng": 0
    },
    "locale": {
      "language": "language",
      "timezone": "timezone",
      "currency": "currency"
    }
  }'

Response 200

{
  "object": "workspace",
  "id": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
  "accountId": "acc_mZp0zVZomHFwUbbYrEqmSM9w",
  "name": "Acme Renovations",
  "businessContext": null,
  "location": null,
  "locale": {
    "language": "en",
    "timezone": "UTC",
    "currency": "USD"
  },
  "businessHours": null,
  "defaultProfileId": "prof_R0CsTy4Qwb8DwkNhFdnXsiVp",
  "retentionDays": 90,
  "createdAt": "2026-10-23T14:51:53.415Z",
  "updatedAt": "2026-10-23T14:51:55.684Z"
}

Was this page helpful?