BlogPosts
Get one BlogPost
Retrieve a single BlogPost record by its Id.
GET
Get one BlogPost
A BlogPost is a location-specific article for the Members Portal, with HTML content, optional images and categories, scheduled publication, audience restrictions, home-page placement, and optional customer comments.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the BlogPost-Read role.Path Parameters
integer
required
The Id of the BlogPost record to retrieve.
Code Examples
Response
200
integer
ID of the location that owns this article..
integer
ID of the optional location-specific language used for this article..
integer
ID of the user attributed as the author; creation assigns the currently authenticated user..
string
Display value for PostedBy.FullName..
string
Required title of the article..
string
Optional short overview displayed with the article..
string
Optional HTML body content of the article..
string
Current file name of the image (read-only; upload via the corresponding URL field).
string
URL of a new file to upload as the image.
boolean
Set to true to remove the current image file.
string
Current file name of the large image (read-only; upload via the corresponding URL field).
string
URL of a new file to upload as the large image.
boolean
Set to true to remove the current large image file.
string
UTC date and time when the public article becomes available; it must be set, and a future value schedules publication..
boolean
Whether to feature the article in the Members Portal home banner before sign-in..
boolean
Whether to feature the article on the Members Portal home page after sign-in..
string
Optional UTC date and time recorded as the article’s unpublish date; leave blank when no unpublish date is required..
boolean
Whether customers can submit comments on this article..
integer[]
List of location-specific blog category IDs assigned to this article; an empty list leaves it uncategorized..
integer
Read-only total number of comments, calculated from BlogPostComment records..
boolean
Whether the article is restricted to contacts, meaning customers without an active contract..
boolean
Whether the article is restricted to members, meaning customers with an active contract..
integer
Unique record identifier.
string
UUID of the record.
string
Date and time the record was created (ISO 8601).
string
Date and time the record was last updated (ISO 8601).
string
Email of the user who last updated this record.
boolean
Whether the record was recently created.
string
External system identifier.
Example Response