Skip to main content
GET
/
api
/
v1
/
link_tag_entity
/
search
/
entities
Get Entities By Tag
curl --request GET \
  --url 'https://api.example.com/api/v1/link_tag_entity/search/entities?api_key='
{
  "data": {
    "items": [
      {
        "tag": {
          "name": "<string>",
          "description": "<string>",
          "color_code": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {}
        },
        "entities": [
          {
            "entity_type": "widget",
            "entity_body": "<unknown>"
          }
        ]
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

tag_term
string
required
page
integer
default:1
Required range: x >= 1
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

data
PageBase[ILinkedEntitiesSearchResponse] · object
required
message
string | null
default:""
meta
Meta · object