Get a list of Tasks
1 min
GET
https://developer.digitail.io/api/v1/tasks
Query Parameters
- filter[pet_id]integerDescription
- filter[query]stringDescription
- filter[record_id]integerDescription
- filter[date_before]string<date>DescriptionFormatdate
- filter[date_after]string<date>DescriptionFormatdate
- filter[updated_after]string<date>DescriptionFormatdate
- filter[only_no_vet]booleanDescription
- filter[include_no_vet]booleanDescription
- filter[only_no_assignee]booleanDescription
- filter[include_no_assignee]booleanDescription
- filter[status]stringDescription
- filter[lifecycle_status]stringExampleDescription
- filter[team_id]stringDescription
- filter[template_id]integerDescription
- includestringDescription
- sortstringDescription
- per_pageintegerDescriptionDefault15Minimum1Maximum1000
Responses
200
- object
- dataobject[]
- idintegerExample
- clinic_idintegerExample
- vet_idinteger
- team_idinteger
- pet_idintegerExample
- room_idintegerExample
- datetime_startstringExampleDescription
- datetime_endstringExampleDescription
- datetime_start_utcstring<date-time>ExampleFormatdate-time
- datetime_end_utcstring<date-time>ExampleFormatdate-time
- precisionstringExample
- titlestringExample
- statusstringExample
- lifecycle_statusstringExample
- notestringExample
- available_for_appointmentsintegerAllowed01
- recurrencestringExample
- record_idinteger
- created_atstring<date-time>ExampleFormatdate-time
- template_idinteger
- templateobject
- idinteger
- namestring
- recurrence_end_on_record_closeboolean
- teamobject
- idinteger
- namestring
- handlestring
- clinic_idinteger
- descriptionstring
- typestring<by_vet | by_vet_type>Allowedby_vetby_vet_type
- statusstring<active | inactive>Allowedactiveinactive
- colorstring
- vet_typesstring[]
- vetsitems[]
- vets_countinteger
- clinicdata
- roomobjectDescription
- idintegerExample
- clinic_idintegerExample
- namestringExample
- linkslinks
- metameta
curl
curl --request GET \
--url 'https://developer.digitail.io/api/v1/tasks?per_page=15' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://developer.digitail.io/api/v1/tasks?per_page=15", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://developer.digitail.io/api/v1/tasks?per_page=15")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://developer.digitail.io/api/v1/tasks?per_page=15"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// successful operation
{
"data": [
{
"id": 1,
"clinic_id": 1,
"vet_id": 0,
"team_id": 0,
"pet_id": 1,
"room_id": 1,
"datetime_start": "2001-06-20 22:03:00",
"datetime_end": "2001-06-20 22:03:00",
"datetime_start_utc": "2023-12-01T09:00:00.000000Z",
"datetime_end_utc": "2023-12-01T10:00:00.000000Z",
"precision": "day",
"title": "ipsum",
"status": "overdue",
"lifecycle_status": "not_started",
"note": "Porro aliquid optio aut ut.",
"available_for_appointments": 0,
"recurrence": "FREQ=DAILY",
"record_id": 0,
"created_at": "2023-12-01T10:00:00.000000Z",
"template_id": 0,
"template": {
"id": 0,
"name": ""
},
"recurrence_end_on_record_close": false,
"team": {
"id": 0,
"name": "",
"handle": "",
"clinic_id": 0,
"description": "",
"type": "",
"status": "",
"color": "",
"vet_types": [
""
],
"vets": [
""
],
"vets_count": 0
},
"clinic": {},
"room": {
"id": 1,
"clinic_id": 1,
"name": "Consultation Room 1"
}
}
],
"links": {},
"meta": {}
}