GET

List Groups

/api/v1/external/groups

Returns all link groups belonging to the authenticated user, sorted alphabetically by name. Use the id values as group_id when creating links.

Authentication

All requests must include a valid API key. See Authentication for setup instructions. 

Authorization: Token YOUR_API_KEY

Query Parameters

This endpoint has no query parameters.

Response 200 OK

A JSON object with a results array. Items are sorted alphabetically by name. 

{
  "results": [
    {
      "id": "018e1b2c-3d4e-7f8a-9b0c-1d2e3f4a5b6c",
      "name": "My Campaign"
    }
  ]
}
Field Type Description
results[].id string (UUID) Unique group identifier. Pass this as group_id when creating a link.
results[].name string Human-readable group name.

Error Responses

Status Description
401 Missing or invalid API key.

Examples

cURL

curl -H "Authorization: Token YOUR_API_KEY" \
https://hozip.com/api/v1/external/groups

Python (requests)

import requests
resp = requests.get(
    "https://hozip.com/api/v1/external/groups",
    headers={"Authorization": "Token YOUR_API_KEY"},
)
resp.raise_for_status()
groups = resp.json()["results"]
# [{"id": "...", "name": "..."}]
Documentation