Block Content
Searching for a text on all fields
If you want to search on the whole fields:
- If you want to save the search on the block settings, you should set the search key on the filters field. For example:
{"fields_filters":{}, "search": "lorem"}
- If you want to apply the search only on a given request, you can send it on the query params: ?seach=lorem
Notes:
- The search term is case-insensitive, so Lorem and lorem are the same.
- On the admin view, the query param (if sent) will override the saved search term. On the public view, the saved search query (if exists) can't be changed.
Searching for a text on a specific field
If you want to search a term on a specific field, you can use this method.
If you want to search a text on an specific field:
- For searching results that have the exact word, use ?fieldSlug=lorem
- For searching the results contain a part of the word, use ?fieldSlug_icontains=lorem or ?fieldSlug_has=lorem
Like the previous item, search term can be either saved on the block settings, or sent on the query params:
- If you want to save the search on the block settings, you should set it in the fields_filters key on the filters field. For example:
{"fields_filters":{"fieldSlug_has": "lorem"}}
- If you want to apply the search only on a given request, you can send it on the query params: ?fieldSlug_has=lorem
Notes:
- The search term is case-insensitive, so Lorem and lorem are the same.
- On the admin view, the query param (if sent) will override the saved search term. On the public view, it will be added to the saved query.
Request
- Base URL: https://api.formaloo.me
- URL: https://api.formaloo.me/v3.0/boards/{boardSlug}/blocks/{blockSlug}/content/
- Auth: none declared. Required headers: x-api-key
Path parameters
Query parameters
Query over the date.
A page number within the paginated result set.
A search query on the list items.
Filter list using timestamps. You can get item on the exact time, before (by adding _lt and _lte), or after that (by adding _gt and _gte) (e.g. submit_time_gte).
Comma seperated list.
Headers
The application secret provided to the client.
The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.
Response
Example response
{
"count": 123,
"next": "https://api.formaloo.net/v1.0/blocks/?page=4",
"previous": "https://api.formaloo.net/v1.0/blocks/?page=2",
"page_size": 10,
"page_count": 13,
"current_page": 3
}Changes
No recorded changes to this operation across all 1 revision of this API.