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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the business linked to this record.
Filter by iD of the language linked to this record.
Filter by iD of the posted by linked to this record.
Filter by full name of the article author.
Filter by article title.
Filter by short overview displayed at the top of the article.
Filter by main body content of the article.
Filter by current file name of the image (read-only; upload via the corresponding URL field).
Filter by uRL of a new file to upload as the image.
Filter by set to true to remove the current image file.
Filter by current file name of the large image (read-only; upload via the corresponding URL field).
Filter by uRL of a new file to upload as the large image.
Filter by set to true to remove the current large image file.
Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication.
Filter by feature this article on the Members Portal home page before users log in.
Filter by feature this article on the Members Portal home page after users log in.
Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
Filter by whether customers can post comments on this article.
Filter by number of comments on this article.
Filter by restrict visibility to contacts (customers without an active contract).
Filter by restrict visibility to members (customers with an active contract).
Range Filters
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.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.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.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.Filter by number of comments on this article greater than or equal to this value.
Filter by number of comments on this article less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Title
Range filters
Response
200
The list of BlogPost records matching the query. See the Get one BlogPost endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search BlogPosts