Location groups

2 endpoints

Named sets of locations a campaign can target as one. Groups are created by the location import (each feature's properties.group); list them here for the ids a campaign's location_group_ids takes, or target them by name with location_group_names.

List location groups#

GET/location-groups

Needs locations:read

Newest first, each with how many locations it holds.

Query parameters

cursor

string

An opaque value from a previous page's meta.next_cursor. Omit for the first page.

limit

integer

How many to return, up to 100.

Default: 20

name

string

Only the group with exactly this name.

Responses

200

200 response

{
  "data": [
    {
      "id": "0192f0a4-6b1e-7c3a-9d2f-5e8b1a4d6001",
      "name": "Bristol stores",
      "location_count": 6,
      "created_at": "2026-09-20T09:12:00+00:00",
      "updated_at": "2026-09-20T09:12:00+00:00"
    }
  ],
  "meta": {
    "next_cursor": null
  }
}

Response fields

data

LocationGroupResource[]

required

data[].id

string

required

data[].name

string

required

data[].location_count

integer

required

data[].created_at

string | null

required

data[].updated_at

string | null

required

meta

object

required

meta.next_cursor

string | null

required

401

The token is missing, unknown, revoked or expired.

missing_tokeninvalid_tokentoken_revokedtoken_expired

missing_token
Missing bearer token.
invalid_token
Unknown API token. Check it was copied in full, and that it is for this environment.
token_revoked
The token "Zapier" was revoked on 2026-10-06 at 18:27 UTC. Issue a new one from Configuration › Platform API.
token_expired
This token has expired. Issue a new one from Configuration › Platform API.

401 response

{
  "error": {
    "code": "missing_token",
    "message": "Missing bearer token."
  }
}

403

The token or workspace can't do this.

missing_abilityplatform_api_not_enabledwrong_environmentworkspace_paused

missing_ability
This token doesn't have the campaigns:write scope.
platform_api_not_enabled
The full Platform API isn't enabled for this workspace yet. Contact customer services to turn it on.
wrong_environment
This is a Sandbox token: use the Sandbox API address. https://api.sandbox.bubbl.tech/platform/v1
workspace_paused
This workspace is scheduled for deletion; its API access is paused.

403 response

{
  "error": {
    "code": "missing_ability",
    "message": "This token doesn't have the campaigns:write scope."
  }
}

422

Something in the request isn't valid. fields says what, with the dashboard's wording.

invalid_cursor

invalid_cursor
That cursor is invalid or has expired.

422 response

{
  "error": {
    "code": "invalid_cursor",
    "message": "That cursor is invalid or has expired."
  }
}

429

Too many requests. Wait for the number of seconds in Retry-After.

rate_limitedtoo_many_failed_attempts

rate_limited
Too many requests. Slow down and try again shortly.
too_many_failed_attempts
Too many failed attempts. Try again shortly.

429 response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and try again shortly."
  }
}

Request

curl 'https://api.bubbl.tech/platform/v1/location-groups?limit=20' \
  -H 'Authorization: Bearer bubbl_YOUR_TOKEN' \
  -H 'Accept: application/json'

Request

const response = await fetch('https://api.bubbl.tech/platform/v1/location-groups?limit=20', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer bubbl_YOUR_TOKEN',
    Accept: 'application/json',
  },
});

const data = await response.json();

Request

import requests

response = requests.request(
    'GET',
    'https://api.bubbl.tech/platform/v1/location-groups?limit=20',
    headers={
        'Authorization': 'Bearer bubbl_YOUR_TOKEN',
        'Accept': 'application/json',
    },
)
response.raise_for_status()
data = response.json()

Request

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bubbl.tech/platform/v1/location-groups?limit=20', [
    'headers' => [
        'Authorization' => 'Bearer bubbl_YOUR_TOKEN',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

Get a location group#

GET/location-groups/{locationGroup}

Needs locations:read

Path parameters

locationGroup

string (uuid)

required

The location group ID

Responses

200

200 response

{
  "data": {
    "id": "0192f0a4-6b1e-7c3a-9d2f-5e8b1a4d6001",
    "name": "Bristol stores",
    "location_count": 6,
    "created_at": "2026-09-20T09:12:00+00:00",
    "updated_at": "2026-09-20T09:12:00+00:00"
  }
}

Response fields

data

LocationGroupResource

required

data.id

string

required

data.name

string

required

data.location_count

integer

required

data.created_at

string | null

required

data.updated_at

string | null

required

401

The token is missing, unknown, revoked or expired.

missing_tokeninvalid_tokentoken_revokedtoken_expired

missing_token
Missing bearer token.
invalid_token
Unknown API token. Check it was copied in full, and that it is for this environment.
token_revoked
The token "Zapier" was revoked on 2026-10-06 at 18:27 UTC. Issue a new one from Configuration › Platform API.
token_expired
This token has expired. Issue a new one from Configuration › Platform API.

401 response

{
  "error": {
    "code": "missing_token",
    "message": "Missing bearer token."
  }
}

403

The token or workspace can't do this.

missing_abilityplatform_api_not_enabledwrong_environmentworkspace_paused

missing_ability
This token doesn't have the campaigns:write scope.
platform_api_not_enabled
The full Platform API isn't enabled for this workspace yet. Contact customer services to turn it on.
wrong_environment
This is a Sandbox token: use the Sandbox API address. https://api.sandbox.bubbl.tech/platform/v1
workspace_paused
This workspace is scheduled for deletion; its API access is paused.

403 response

{
  "error": {
    "code": "missing_ability",
    "message": "This token doesn't have the campaigns:write scope."
  }
}

404

Nothing with that ID in this workspace.

not_found

not_found
No such resource in this workspace.

404 response

{
  "error": {
    "code": "not_found",
    "message": "No such resource in this workspace."
  }
}

429

Too many requests. Wait for the number of seconds in Retry-After.

rate_limitedtoo_many_failed_attempts

rate_limited
Too many requests. Slow down and try again shortly.
too_many_failed_attempts
Too many failed attempts. Try again shortly.

429 response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and try again shortly."
  }
}

Request

curl 'https://api.bubbl.tech/platform/v1/location-groups/{locationGroup}' \
  -H 'Authorization: Bearer bubbl_YOUR_TOKEN' \
  -H 'Accept: application/json'

Request

const response = await fetch('https://api.bubbl.tech/platform/v1/location-groups/{locationGroup}', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer bubbl_YOUR_TOKEN',
    Accept: 'application/json',
  },
});

const data = await response.json();

Request

import requests

response = requests.request(
    'GET',
    'https://api.bubbl.tech/platform/v1/location-groups/{locationGroup}',
    headers={
        'Authorization': 'Bearer bubbl_YOUR_TOKEN',
        'Accept': 'application/json',
    },
)
response.raise_for_status()
data = response.json()

Request

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bubbl.tech/platform/v1/location-groups/{locationGroup}', [
    'headers' => [
        'Authorization' => 'Bearer bubbl_YOUR_TOKEN',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);