Get elements by tag

GET {{baseUrl}}/tags/{{slugId}}/entities

Gets Qodex elements (entities) by a given tag. Tags enable you to organize and search [workspaces] [APIs] and [collections] that contain shared tags.

Note:

Tagging is available on [Qodex Enterprise plans]

Request Params

KeyDatatypeRequiredDescription
limitstringThe maximum number of tagged elements to return in a single call.
directionstringThe ascending (asc) or descending (desc) order to sort the results by, based on the time of the element's tagging.
cursorstringThe cursor to get the next set of results in the paginated response. Use the nextCursor value in the response's meta object for this value.

If you pass an invalid value, the API only returns the first set of results. | | entityType | string | | Filter results for the given element type:

  • api
  • collection
  • workspace |

RESPONSES

status: OK

{"data":{"entities":[{"entityId":"12345678-6fd634a3-79ba-451d-8f07-56a953f96667","entityType":"collection"},{"entityId":"7a95cfe8-de72-44e6-81ea-79d19805bd7b","entityType":"api"}]},"meta":{"count":2,"nextCursor":"eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ=="}}