Skip to main content
GET
Search BlogPosts
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-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the location that owns this article..
integer
Filter by iD of the optional location-specific language used for this article..
integer
Filter by iD of the user attributed as the author; creation assigns the currently authenticated user..
string
Filter by display value for PostedBy.FullName..
string
Filter by required title of the article..
string
Filter by optional short overview displayed with the article..
string
Filter by optional HTML body content of the article..
string
Filter by current file name of the image (read-only; upload via the corresponding URL field).
string
Filter by uRL of a new file to upload as the image.
boolean
Filter by set to true to remove the current image file.
string
Filter by current file name of the large image (read-only; upload via the corresponding URL field).
string
Filter by uRL of a new file to upload as the large image.
boolean
Filter by set to true to remove the current large image file.
string
Filter by uTC date and time when the public article becomes available; it must be set, and a future value schedules publication..
boolean
Filter by whether to feature the article in the Members Portal home banner before sign-in..
boolean
Filter by whether to feature the article on the Members Portal home page after sign-in..
string
Filter by optional UTC date and time recorded as the article’s unpublish date; leave blank when no unpublish date is required..
boolean
Filter by whether customers can submit comments on this article..
integer
Filter by read-only total number of comments, calculated from BlogPostComment records..
boolean
Filter by whether the article is restricted to contacts, meaning customers without an active contract..
boolean
Filter by whether the article is restricted to members, meaning customers with an active contract..

Range Filters

string
Filter by uTC date and time when the public article becomes available; it must be set, and a future value schedules publication. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the public article becomes available; it must be set, and a future value schedules publication. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by optional UTC date and time recorded as the article’s unpublish date; leave blank when no unpublish date is required. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by optional UTC date and time recorded as the article’s unpublish date; leave blank when no unpublish date is required. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by read-only total number of comments, calculated from BlogPostComment records. greater than or equal to this value.
integer
Filter by read-only total number of comments, calculated from BlogPostComment records. less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200

BlogPost[]
The list of BlogPost records matching the query. See the Get one BlogPost endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each BlogPost. The following fields are not populated in the Records[] response: FullText, ShowInHomeBanner, ShowInHomePage, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one BlogPost endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response