Form
List Form
Endpoint to list all Form items
post/form/get-list
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"name": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"targetType": true,
"logoAltText": true
},
"sort": {
"createdAt": "DESC"
}
}Response
Successful response
Example response
{
"data": [
{
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Report a Problem",
"description": "# Heading\n\nThis is **markdown** content",
"isEnabled": true,
"shareKey": "123e4567-e89b-12d3-a456-426614174000",
"targetType": "Incident",
"fields": {
"key": "value",
"nested": {
"data": 123
}
},
"templates": {
"key": "value",
"nested": {
"data": 123
}
},
"targetSettings": {
"key": "value",
"nested": {
"data": 123
}
},
"successMessage": "# Heading\n\nThis is **markdown** content",
"ipWhitelist": "203.0.113.0/24\n198.51.100.7",
"logoFileId": "123e4567-e89b-12d3-a456-426614174000",
"logoAltText": "Acme Inc.",
"faviconFileId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.