---
title: Get a list of Taggables
slug: import-test-pdf/get-a-list-of-taggables
createdAt: 2025-10-28T16:28:34.276Z
---

{
  "id": "1XDwrpLIQGPel97dzHxwo",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "/api/v1/taggables",
    "servers": [],
    "name": "Get a list of Taggables",
    "description": "<p>Returns list of Taggables (relation between an entity (pet|client) and a tag)</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "filter[entity_type]",
          "type": "string",
          "description": "<p>Entity Type (Ex. App\\Models\\Pet, Pet, pet; user)</p>"
        },
        {
          "kind": "optional",
          "name": "filter[entity_id]",
          "type": "integer",
          "description": "<p>Entity ID (required if filter[tag_id] is not set)</p>"
        },
        {
          "kind": "optional",
          "name": "filter[tag_id]",
          "type": "integer",
          "description": "Tag Id"
        },
        {
          "kind": "optional",
          "name": "filter[color_level]",
          "type": "integer",
          "description": "<p>Tag Color (any hex color, ex:#FF0000)</p>"
        },
        {
          "kind": "optional",
          "name": "include",
          "type": "string",
          "description": "<p>Additional relation to include(ex:tag)</p>",
          "default": "tag"
        }
      ],
      "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/Taggable",
                "customType": "Taggable[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "integer",
                    "description": "",
                    "example": 1
                  },
                  {
                    "name": "entity_type",
                    "kind": "optional",
                    "type": "string",
                    "description": "",
                    "example": "App\\\\Models\\\\Pet"
                  },
                  {
                    "name": "entity_id",
                    "kind": "optional",
                    "type": "integer",
                    "description": "",
                    "example": 1
                  },
                  {
                    "name": "tag_id",
                    "kind": "optional",
                    "type": "integer",
                    "description": "",
                    "example": 1
                  },
                  {
                    "name": "created_at",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "",
                    "example": "2021-11-15T11:37:46.000000Z"
                  },
                  {
                    "name": "deleted_at",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "",
                    "example": ""
                  },
                  {
                    "name": "tag",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/Tag",
                    "customType": "Tag",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "integer",
                        "description": "",
                        "example": 1
                      },
                      {
                        "name": "entity_type",
                        "kind": "optional",
                        "type": "string",
                        "description": "",
                        "example": "App\\\\Models\\\\Pet"
                      },
                      {
                        "name": "clinic_id",
                        "kind": "optional",
                        "type": "integer",
                        "description": "",
                        "example": 766
                      },
                      {
                        "name": "color_level",
                        "kind": "optional",
                        "type": "string",
                        "description": "",
                        "example": "#FF0000"
                      },
                      {
                        "name": "value",
                        "kind": "optional",
                        "type": "string",
                        "description": "",
                        "example": "Happy"
                      },
                      {
                        "name": "created_at",
                        "kind": "optional",
                        "type": "string<date-time>",
                        "description": "",
                        "example": "2021-10-05T12:52:53.000000Z"
                      },
                      {
                        "name": "deleted_at",
                        "kind": "optional",
                        "type": "string<date-time>",
                        "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/taggables?filter[entity_type]=string&include=tag' \\\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/taggables?filter[entity_type]=string&include=tag\", 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/taggables?filter[entity_type]=string&include=tag\")\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/taggables?filter[entity_type]=string&include=tag\"\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      \"entity_type\": \"App\\\\\\\\Models\\\\\\\\Pet\",\n      \"entity_id\": 1,\n      \"tag_id\": 1,\n      \"created_at\": \"2021-11-15T11:37:46.000000Z\",\n      \"deleted_at\": \"\",\n      \"tag\": {\n        \"id\": 1,\n        \"entity_type\": \"App\\\\\\\\Models\\\\\\\\Pet\",\n        \"clinic_id\": 766,\n        \"color_level\": \"#FF0000\",\n        \"value\": \"Happy\",\n        \"created_at\": \"2021-10-05T12:52:53.000000Z\",\n        \"deleted_at\": \"\"\n      }\n    }\n  ],\n  \"links\": {},\n  \"meta\": {}\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}