Skip to main content
gbp:read The gbp:read scope allows you to list and retrieve Google Business Profile posts managed through Hrizn.

​
Endpoints

MethodPathDescription
GET/public/gbp/postsList GBP posts
GET/public/gbp/posts/{id}Get a single GBP post

​
List GBP posts

GET /public/gbp/posts
Returns a paginated list of GBP posts for your site.

​
Query parameters

ParameterTypeDefaultDescription
limitinteger25Max posts to return (1-100)
offsetinteger0Skip this many posts
statusstring—Filter: posted, scheduled, cancelled, failed, draft, deleted
location_idstring—Filter by GBP location ID

​
Example

curl https://api.app.hrizn.io/v1/public/gbp/posts?limit=10&status=posted \
  -H "X-API-Key: hzk_your_key_here"

​
Response

{
  "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",
      "posted_at": "2026-03-20T10:30:00.000Z",
      "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": "10"
  }
}

​
Get a single GBP post

GET /public/gbp/posts/{id}
Returns full details for a post by its UUID.

​
Example

curl https://api.app.hrizn.io/v1/public/gbp/posts/a1b2c3d4-5678-9012-3456-789012345678 \
  -H "X-API-Key: hzk_your_key_here"

​
Status codes

StatusDescription
200Success
401Missing or invalid API key
403API key lacks gbp:read scope
404Post not found
429Rate limit exceeded
500Internal error

​
Missing scope error

{
  "error": {
    "code": "forbidden",
    "message": "This API key requires one of the following scopes: gbp:read",
    "details": {
      "required_scopes": ["gbp:read"]
    }
  }
}
Last modified on March 27, 2026