Skip to main content
GET
/
gbp
/
posts
List GBP posts
curl --request GET \
  --url https://api.app.hrizn.io/v1/public/gbp/posts \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "a1b2c3d4-5678-9012-3456-789012345678",
      "google_post_id": "accounts/123/locations/456/localPosts/789",
      "location_id": "locations/456",
      "post_type": "NEWS",
      "content_text": "Check out our latest spring specials!",
      "status": "posted",
      "media_url": null,
      "posted_at": "2026-03-20T10:30:00.000Z",
      "publish_at_utc": null,
      "scheduled_timezone": null,
      "post_config": {
        "media_url": null,
        "event_title": null,
        "action_type": null
      },
      "created_at": "2026-03-20T10:30:00.000Z",
      "updated_at": "2026-03-20T10:30:00.000Z"
    }
  ],
  "pagination": {
    "total_count": 42,
    "has_more": true,
    "next_cursor": "25"
  }
}
Returns a paginated list of GBP posts for your site. Scope required: gbp:read

Query parameters

limit
integer
default:"25"
Maximum number of posts to return (1-100).
offset
integer
default:"0"
Number of posts to skip for pagination.
status
string
Filter by status: posted, scheduled, cancelled, failed, draft, or deleted.
location_id
string
Filter by GBP location ID.

Response

Returns an array of posts with pagination metadata.
{
  "data": [
    {
      "id": "a1b2c3d4-5678-9012-3456-789012345678",
      "google_post_id": "accounts/123/locations/456/localPosts/789",
      "location_id": "locations/456",
      "post_type": "NEWS",
      "content_text": "Check out our latest spring specials!",
      "status": "posted",
      "media_url": null,
      "posted_at": "2026-03-20T10:30:00.000Z",
      "publish_at_utc": null,
      "scheduled_timezone": null,
      "post_config": {
        "media_url": null,
        "event_title": null,
        "action_type": null
      },
      "created_at": "2026-03-20T10:30:00.000Z",
      "updated_at": "2026-03-20T10:30:00.000Z"
    }
  ],
  "pagination": {
    "total_count": 42,
    "has_more": true,
    "next_cursor": "25"
  }
}

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Query Parameters

limit
integer
default:25

Maximum number of posts to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of posts to skip for pagination

status
enum<string>

Filter by post status

Available options:
posted,
scheduled,
cancelled,
failed,
draft,
deleted
location_id
string

Filter by GBP location ID

Response

Paginated list of GBP posts

data
object[]
pagination
object
Last modified on March 27, 2026