--- title: Get a list of Tasks slug: get-a-list-of-tasks createdAt: 2026-10-06T09:14:24.169Z --- { "id": "62iMykMTHDOLsJI-neZMg", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://developer.digitail.io/api/v1/tasks", "servers": [ { "url": "https://developer.digitail.io/api/v1/tasks", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/tasks", "description": "Production server (uses live data)" } ], "name": "Get a list of Tasks", "description": "

Permissions needed: VIEW_TASKS

\n

Returns the tasks of the clinics in filter[clinic_id], which is required. The connected user must work at every clinic listed. Newest first by default. Page through with page and per_page (up to 1000) to read all of them.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "filter[pet_id]", "type": "integer", "description": "Pet ID" }, { "kind": "optional", "name": "filter[query]", "type": "string", "description": "Search query string" }, { "kind": "optional", "name": "filter[record_id]", "type": "integer", "description": "Record ID" }, { "kind": "optional", "name": "filter[date_before]", "type": "string", "description": "

Date before(Y-m-d)

", "format": "date" }, { "kind": "optional", "name": "filter[date_after]", "type": "string", "description": "

Date after(Y-m-d)

", "format": "date" }, { "kind": "optional", "name": "filter[updated_after]", "type": "string", "description": "

Date updated_at after(Y-m-d)

", "format": "date" }, { "kind": "optional", "name": "filter[only_no_vet]", "type": "boolean", "description": "only without vet" }, { "kind": "optional", "name": "filter[include_no_vet]", "type": "boolean", "description": "include without vet as well" }, { "kind": "optional", "name": "filter[only_no_assignee]", "type": "boolean", "description": "only tasks without a vet and without a team" }, { "kind": "optional", "name": "filter[include_no_assignee]", "type": "boolean", "description": "also include tasks without a vet and without a team" }, { "kind": "optional", "name": "filter[status]", "type": "string", "description": "

Status (comma separated values - due, done, overdue))

" }, { "kind": "optional", "name": "filter[lifecycle_status]", "type": "string", "example": "not_started,in_progress", "description": "

Lifecycle status, comma separated: not_started, in_progress, waiting, completed

" }, { "kind": "optional", "name": "filter[team_id]", "type": "string", "description": "

Team ID, or several comma separated

" }, { "kind": "optional", "name": "filter[template_id]", "type": "integer", "description": "Template ID" }, { "kind": "optional", "name": "include", "type": "string", "description": "

Additional info to include(room, vet, vet.multipleClinic, pet, pet.species, pet.breed, pet.clinicObservation, owner, owner.clinicObservation, notes, clinic, clinic.rooms, soap, notesCount, activities, activities.causer, template, team)

" }, { "kind": "optional", "name": "sort", "type": "string", "description": "

Sort by. You can use multiple, comma separated. Options: datetime_start_utc, created_at, id.

" }, { "kind": "optional", "name": "per_page", "type": "integer", "description": "Number of tasks per page", "default": 15, "minimum": 1, "maximum": 1000 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "vet_id", "kind": "optional", "type": "integer", "nullable": true, "description": "" }, { "name": "team_id", "kind": "optional", "type": "integer", "nullable": true, "description": "" }, { "name": "pet_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "room_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "datetime_start", "kind": "optional", "type": "string", "description": "In the clinic's time zone", "example": "2001-06-20 22:03:00" }, { "name": "datetime_end", "kind": "optional", "type": "string", "description": "In the clinic's time zone", "example": "2001-06-20 22:03:00" }, { "name": "datetime_start_utc", "kind": "optional", "type": "string", "description": "", "example": "2023-12-01T09:00:00.000000Z", "format": "date-time" }, { "name": "datetime_end_utc", "kind": "optional", "type": "string", "description": "", "example": "2023-12-01T10:00:00.000000Z", "format": "date-time" }, { "name": "precision", "kind": "optional", "type": "string", "description": "", "example": "day" }, { "name": "title", "kind": "optional", "type": "string", "description": "", "example": "ipsum" }, { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "overdue" }, { "name": "lifecycle_status", "kind": "optional", "type": "string", "description": "", "example": "not_started" }, { "name": "note", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Porro aliquid optio aut ut." }, { "name": "available_for_appointments", "kind": "optional", "type": "integer", "description": "", "example": 0, "enum": [ "0", "1" ] }, { "name": "recurrence", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "FREQ=DAILY" }, { "name": "record_id", "kind": "optional", "type": "integer", "nullable": true, "description": "" }, { "name": "created_at", "kind": "optional", "type": "string", "description": "", "example": "2023-12-01T10:00:00.000000Z", "format": "date-time" }, { "name": "template_id", "kind": "optional", "type": "integer", "nullable": true, "description": "" }, { "name": "template", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "recurrence_end_on_record_close", "kind": "optional", "type": "boolean", "nullable": true, "description": "" }, { "name": "team", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "handle", "kind": "optional", "type": "string", "description": "" }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "by_vet", "by_vet_type" ] }, { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "active", "inactive" ] }, { "name": "color", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "vet_types", "kind": "optional", "type": "array", "nullable": true, "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "vets", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1vets~1%7Bid%7D~1colleagues-calendar-order/get/responses/200/content/application~1json/schema/properties/data/items", "customType": "items[]", "schema": [] }, { "name": "vets_count", "kind": "optional", "type": "integer", "nullable": true, "description": "" } ] }, { "name": "clinic", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1clinic~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data", "customType": "data", "schema": [] }, { "name": "room", "kind": "optional", "type": "object", "nullable": true, "description": "A room in a clinic where appointments can be made. Used for organizational purposes.", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Consultation Room 1" } ] } ] }, { "name": "links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links", "customType": "links", "schema": [] }, { "name": "meta", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta", "customType": "meta", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "h5-DFJJmVq9Lkopt1PAPW", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://developer.digitail.io/api/v1/tasks?per_page=15' \\\n --header 'accept: application/json'" }, { "id": "Rb3zGhiv4TuMkELKRhyrX", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/tasks?per_page=15\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "qO3anrZ_11pigsn64HMGE", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/tasks?per_page=15\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "P6_IaTj2XzKhVjHzbSo1k", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/tasks?per_page=15\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "h5-DFJJmVq9Lkopt1PAPW" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// successful operation\n{\n \"data\": [\n {\n \"id\": 1,\n \"clinic_id\": 1,\n \"vet_id\": 0,\n \"team_id\": 0,\n \"pet_id\": 1,\n \"room_id\": 1,\n \"datetime_start\": \"2001-06-20 22:03:00\",\n \"datetime_end\": \"2001-06-20 22:03:00\",\n \"datetime_start_utc\": \"2023-12-01T09:00:00.000000Z\",\n \"datetime_end_utc\": \"2023-12-01T10:00:00.000000Z\",\n \"precision\": \"day\",\n \"title\": \"ipsum\",\n \"status\": \"overdue\",\n \"lifecycle_status\": \"not_started\",\n \"note\": \"Porro aliquid optio aut ut.\",\n \"available_for_appointments\": 0,\n \"recurrence\": \"FREQ=DAILY\",\n \"record_id\": 0,\n \"created_at\": \"2023-12-01T10:00:00.000000Z\",\n \"template_id\": 0,\n \"template\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"recurrence_end_on_record_close\": false,\n \"team\": {\n \"id\": 0,\n \"name\": \"\",\n \"handle\": \"\",\n \"clinic_id\": 0,\n \"description\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"color\": \"\",\n \"vet_types\": [\n \"\"\n ],\n \"vets\": [\n \"\"\n ],\n \"vets_count\": 0\n },\n \"clinic\": {},\n \"room\": {\n \"id\": 1,\n \"clinic_id\": 1,\n \"name\": \"Consultation Room 1\"\n }\n }\n ],\n \"links\": {},\n \"meta\": {}\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }