Support for

TCAPI: tag group

John Valentine
by John Valentine 5 years ago
 

Retrieves a tag group, or lists tag groups.

Request tag group by id

Syntax
/tag_groups/<taggroup_id>/

Retrieves a tag group.

Parameter Description
user_key Your application’s key, from developer.templatecloud.com 
format json or xml
include List more data containers. Possible value: tag_type.

After /tag_groups/, specify the id of the tag group like this:

HTTP request
GET http://api.templatecloud.com/sandbox/tag_groups/2/?user_key=ba386e729c5f6870cea89f38e92d7a5c&format=json
HTTP response (JSON)
{
    "tag_group": {
        "id": "2",
        "name": "Easter",
        "tagtype_id": "8",
    }
}

Request list of tag groups

Syntax
/tag_groups/

Retrieves all tag groups, using optional filters.

Parameter Description
user_key Your application’s key, from developer.templatecloud.com 
format json or xml
type_id One tag type id (optional)
include List more data containers. Possible value: tag_type.
HTTP request
GET http://api.templatecloud.com/sandbox/tag_groups/?user_key=ba386e729c5f6870cea89f38e92d7a5c&format=json
HTTP response (JSON)
{
   "tag_groups": [
      {
         "id": "1",
         "name": "Other Events",
         "tagtype_id": "8"
      },
      {
         "id": "2",
         "name": "Easter",
         "tagtype_id": "8"
      },
         ...
}

Relations

References to tag groups

  • Use tag_type.id to find tag groups having that tag type:

    Syntax
    /tag_groups/...?type_id=<tagtype_id>
  • Use template.tag.taggroup_id to get a tag group from a template:

    Syntax
    /tag_groups/<taggroup_id>/

References from tag groups

  • Use tag_group.id to find templates having tags belonging to that tag group:

    Syntax
    /templates/?…filter_options=0&type_id=<tagtype_id>
  • Use tag_group.id to find template filters for templates having tags in that tag group:

    Syntax
    /templates/?…filter_options=1&type_id=<tagtype_id>
  • Use tag_group.tagtype_id to get a single tag type:

    Syntax
    /tag_types/<tagtype_id>/

Self-references in tag groups

  • Use tag_group.id to get a single tag group:

    Syntax
    /tag_groups/<taggroup_id>/
  • Use tag_group.tagtype_id to find tag groups having that tag type:

    Syntax
    /tag_groups/?type_id=<taggroup_id>

Other references using tag groups

  • Use template.tag.taggroup_id to find all templates having that tag group:

    Syntax
    /templates/?group_id=<taggroup_id>
 

See also

Getting your App Approved

Jump to contents page of

TemplateCloud API Guide

 
 
 

All content is (c) Grafenia Operations Limited, 2020 and may not be used, copied or distributed without permission.