--- title: Get a list of Records(File Cases) slug: import-test-pdf/get-a-list-of-recordsfile-cases createdAt: 2025-10-28T16:28:34.271Z --- { "id": "goGpAd6pIwRPGROpA6iut", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/v1/records", "servers": [], "name": "Get a list of Records(File Cases)", "description": "Returns list of Records", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "required", "name": "filter[pet_id]", "type": "integer", "description": "Pet ID" }, { "kind": "optional", "name": "filter[id]", "type": "integer", "description": "Record ID" }, { "kind": "optional", "name": "filter[sale_id]", "type": "integer", "description": "Sale ID" }, { "kind": "optional", "name": "filter[has_diagnoses]", "type": "integer", "description": "

Return only the records(file cases) that have a diagnoses attached(Ex: 1 - true; 0 - false)

" }, { "kind": "optional", "name": "filter[has_labs]", "type": "integer", "description": "

Return only the records(file cases) that have Labs(Ex: 0 - false; 1 - true(will also automatically include the 'values' field);)

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

Include additional relations(Ex: selectedDiagnoses)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Record", "customType": "Record[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "number", "kind": "optional", "type": "string", "description": "", "example": "175" }, { "name": "status", "kind": "optional", "type": "integer", "description": "`0` - Draft `1` - Saved `2` - Closed `3` - Hospitalized\n", "example": 1 }, { "name": "vet_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "pet_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "sale_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "date", "kind": "optional", "type": "string", "description": "", "example": "2021-11-19" }, { "name": "reason", "kind": "optional", "type": "string", "description": "", "example": "Routine checkup" }, { "name": "template_id", "kind": "optional", "type": "integer", "description": "", "example": 0 }, { "name": "comments", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "recommendations", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "rabic_tag_number", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "presumptive_diagnosis", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "diagnosis", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "treatment", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "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": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url '/api/v1/records?filter[pet_id]=integer' \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "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(\"/api/v1/records?filter[pet_id]=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/v1/records?filter[pet_id]=integer\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/api/v1/records?filter[pet_id]=integer\"\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": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// successful operation\n{\n \"data\": [\n {\n \"id\": 1,\n \"number\": \"175\",\n \"status\": 1,\n \"vet_id\": 1,\n \"clinic_id\": 1,\n \"pet_id\": 1,\n \"sale_id\": 1,\n \"date\": \"2021-11-19\",\n \"reason\": \"Routine checkup\",\n \"template_id\": 0,\n \"comments\": \"\",\n \"recommendations\": \"\",\n \"rabic_tag_number\": \"\",\n \"presumptive_diagnosis\": \"\",\n \"diagnosis\": \"\",\n \"treatment\": \"\"\n }\n ],\n \"links\": {},\n \"meta\": {}\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }