Loading ...

REST API: Get Tags | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Tags » REST API: Get Tags
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Get Tags

0 
 /5
0 (0votes)
Open API Guide
GET/api/tags

Returns a list of tags based on the parameters specified in the URL. List of supported entities: Articles, Blogs, Wikis, Files, Videos, Ideas, Photos, Albums, Forum Topics, Forum Posts.

To find the content carrying a tag, use REST API: Search. This endpoint returns tag names, IDs and counts only. Pass the TagID to the search endpoint, which accepts tags with no keyword at all, to get the items themselves.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOQueryUnique ID of the space from which the content is to be returned.Don't pass any value to it if you want content from every space
EntityTypeStringNOQueryThe entity type of the content to be returned. Here are the values of Entity Type parameter: Article = 3, Blog = 4, Photo = 6, Video = 7, Wiki = 9, File = 14, Album = 18, Idea = 44, ForumPost = 54 ForumTopic = 55.
SearchTextStringNOQueryThe search keyword to return content for
SortByIntegerNOQueryColumn to sort by: TagName = 1, Count = 2, TagNameWithTopCount = 3.
SortOrderStringNOQuerySort direction: Ascending = 0, Descending = 1.
StartPageIntegerNOQueryPage of results to return. Default: 1.
PageLengthIntegerNOQueryNumber of results to return per page. Default: 30.
EntityIDIntegerNOQueryFilter tags by a specific entity ID
ContentTypeIDIntegerNOQueryFilter tags by content type ID
FieldUseIDIntegerNOQueryFilter tags by the field use ID (for custom field tags)
FieldDataIDIntegerNOQueryFilter tags by the field data ID
SpacesForCurrentUserBooleanNOQuerySet to true to limit the tags to spaces where the caller can read the EntityType; with SpaceID and EntityType both sent and no permission in that space, the response is a bare empty list.
IsPromotedBooleanNOQueryWhich tags to return: true returns only promoted tags, false (the default) returns only standard tags, and leaving it out of the query string entirely still applies the default of false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/tags?sortby=2&sortorder=1&pagelength=50

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "TagID": 3,
      "TagName": "human-resources",
      "EntityID": 220,
      "EntityType": 1,
      "SpaceID": 252,
      "TagWeight": 0,
      "TagCount": 49
    },
    {
      "TagID": 2,
      "TagName": "marketing",
      "EntityID": 220,
      "EntityType": 1,
      "SpaceID": 252,
      "TagWeight": 0,
      "TagCount": 33
    },
    {
      "TagID": 12,
      "TagName": "sales",
      "EntityID": 220,
      "EntityType": 1,
      "SpaceID": 252,
      "TagWeight": 0,
      "TagCount": 31
    },
    {
      "TagID": 14,
      "TagName": "announcement",
      "EntityID": 220,
      "EntityType": 1,
      "SpaceID": 252,
      "TagWeight": 0,
      "TagCount": 5
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages