GET Endpoints
Retrieve Single Resource
Fetch a specific resource using its unique identifier
GET /example/{id}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
numeric | Yes | Unique identifier of the resource |
Example Response
{
"id": "123",
"name": "Example Resource",
"description": "A single example resource"
}
Status Codes
| Code | Description |
|---|---|
200 OK |
Resource successfully retrieved |
404 Not Found |
Resource with specified ID does not exist |
List Resources
Retrieve a collection of resources with optional filtering
GET /example/
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer | No | Maximum items to return |
offset |
integer | No | Number of items to skip |
idAfter |
integer | No | Only include items with higher ID |
createdSince |
datetime | No | Only include items created since |
updatedSince |
datetime | No | Only include items updated since |
Example Response
[
{
"id": "123",
"name": "First Example",
"description": "An example resource"
},
{
"id": "124",
"name": "Second Example",
"description": "Another example resource"
}
]
Status Codes
| Code | Description |
|---|---|
200 OK |
Resources successfully retrieved |
400 Bad Request |
Invalid query parameters |
Timestamp Filters
All *Since filters operate on system timestamps rather than resource dates. They filter based on when an action occurred in the system, not dates stored within the resource itself.
Date & Time Formats
Dates
Format: YYYY-MM-DD
Example: 2024-11-25
Validation Rules
- Must be full dates (YYYY-MM-DD)
- Years must be four digits
- Months and days must be two digits (pad with leading zeros)
- Partial dates (YYYY-MM) are not accepted
- Time components are not allowed
- No timezone offset is allowed
Datetimes
Format: YYYY-MM-DDTHH:mm:ssZ
Example: 2024-11-25T08:30:00Z
Validation Rules
- Must include full date and time components
- The
Tdelimiter between date and time is required - Hours, minutes, and seconds must be two digits (pad with leading zeros)
- Seconds are required (HH:mm is not accepted)
- May include timezone designator