Entries
GET /api/v1/entries
Returns a list of entries.
Parameters
| Parameter | Description | Type |
|---|---|---|
title | Filter on the title of the entries. | string |
author | Filter on the author of the entries. | string |
sort | Comma separated list of fields to use for sort. Use field_name to sort in ascending order and -field_name to sort in descending order. | string |
limit | Limits the number of results. | number |
page | The page to be returned. The limit option must be present for this to work. | number |
fields | Comma separated list of fields to show. | string |
firstPublished | Can be a string like firstPublished=2022-12-12 or a nested object like firstPublished[$gt]=2022-12-12. | string or object |
lastUpdated | Can be a string like lastUpdated=2022-12-12 or a nested object like lastUpdated[$gt]=2022-12-12. | string or object |
Example Requests
All entries:
curl $BASE_URL/api/v1/entries
All entries with title "Abduction":
curl $BASE_URL/api/v1/entries?title=Abduction
All entries with author "Douven, Igor":
curl $BASE_URL/api/v1/entries?author=Douven,%20Igor
All entries sorted by author in descending order:
curl $BASE_URL/api/v1/entries?sort=author
All entries sorted by author in ascending order:
curl $BASE_URL/api/v1/entries?sort=-author
The first 10 entries:
curl $BASE_URL/api/v1/entries?limit=10
The 3rd page, with 10 entries per page (i.e. skips the firs 20 entries entries and returns the next 10 entries):
curl $BASE_URL/api/v1/entries?limit=10&page=3
Returns only the field title:
curl $BASE_URL/api/v1/entries?fields=title
All entries published on 2022-12-12:
curl $BASE_URL/api/v1/entries?firstPublished=2022-12-12
All entries published since 2022-12-12:
curl $BASE_URL/api/v1/entries?firstPublished[$gte]=2022-12-12
The possible operators are: $gte for greater than or equal, $gt for greater than, $lte for less than or equal, and $lt for less than.
All entries last updated on 2022-12-12:
curl $BASE_URL/api/v1/entries?lastUpdated=2022-12-12
All entries last updated since 2022-12-12:
curl $BASE_URL/api/v1/entries?lastUpdated[$gte]=2022-12-12
The possible operators are: $gte for greater than or equal, $gt for greater than, $lte for less than or equal, and $lt for less than.
Example Response
[
{
"_id": "637c6e4aab7ffc771756ef2b",
"identifier": "abduction",
"title": "Abduction",
"author": "Douven, Igor",
"firstPublishedDate": "2011-03-09T00:00:00.000Z",
"lastUpdatedDate": "2021-05-18T00:00:00.000Z",
"preamble": "In the philosophical literature, ...",
"__v": 0
},
{
"_id": "637c6e4aab7ffc771756ef2c",
"identifier": "abelard",
"title": "Peter Abelard",
"author": "King, Peter",
"firstPublishedDate": "2004-08-03T00:00:00.000Z",
"lastUpdatedDate": "2022-08-12T00:00:00.000Z",
"preamble": "Peter Abelard (1079–21 April 1142) ...",
"__v": 0
},
...
]
GET /api/v1/entries/:entry
Returns the entry with the given identifier.
Parameters
| Parameter | Description | Type |
|---|---|---|
:entry | The identifier of the entry to be returned. | string |
Example Request
curl $BASE_URL/api/v1/entries/abduction
Example Response
{
"_id": "637c6e4aab7ffc771756ef2b",
"identifier": "abduction",
"title": "Abduction",
"author": "Douven, Igor",
"firstPublishedDate": "2011-03-09T00:00:00.000Z",
"lastUpdatedDate": "2021-05-18T00:00:00.000Z",
"preamble": "In the philosophical literature, ...",
"__v": 0
}