Articles
Search BlogPosts
Search and list BlogPost records with filtering, sorting, and pagination.
GET
Search BlogPosts
A BlogPost represents an article published on the Members Portal. Articles can be used to share news, updates, or useful content with customers.
Articles support scheduled publishing via
PublishDate and automatic unpublishing via UnpublishDate. Setting a PublishDate in the past publishes the article immediately; setting a future date schedules it. Leaving UnpublishDate blank keeps the article published until it is manually unpublished or deleted.
Each article has a SummaryText (short overview displayed at the top) and a FullText (the main body content). Articles can be organised into categories using the BlogCategory entity and can optionally allow customer comments.
Visibility can be controlled with OnlyForMembers (customers with an active contract) and OnlyForContacts (customers without an active contract). Articles can also be featured on the Members Portal home page before login (ShowInHomeBanner) or after login (ShowInHomePage).
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 business linked to this record.
integer
Filter by iD of the language linked to this record.
integer
Filter by iD of the posted by linked to this record.
string
Filter by full name of the article author.
string
Filter by article title.
string
Filter by short overview displayed at the top of the article.
string
Filter by main 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 date and time when the article is published. Past dates publish immediately; future dates schedule publication.
boolean
Filter by feature this article on the Members Portal home page before users log in.
boolean
Filter by feature this article on the Members Portal home page after users log in.
string
Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
boolean
Filter by whether customers can post comments on this article.
integer
Filter by number of comments on this article.
boolean
Filter by restrict visibility to contacts (customers without an active contract).
boolean
Filter by restrict visibility to members (customers with an active contract).
Range Filters
string
Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by number of comments on this article greater than or equal to this value.
integer
Filter by number of comments on this article 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.
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
Search BlogPosts