Skip to main content

pages/{pageid}/tags (GET)


Retrieve the tags on a page.

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
pageid string either an integer page ID, "home", or "=" followed by a double uri-encoded page title

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
redirects int? If zero, do not follow page redirects.
export bool? Strip tag xml of site specific information (default: false

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 Read access to the page is required
Not Found 404 The requested page could not be found

Message Format


<tags count="{int}" href="{uri}">
    <tag value="{text}">
        <related count="{int}">
            <page id="{int}" href="{uri}">

C# Code Sample: Retrieve Page Tags

The following code example retrieves the tags on the page called "Page Title":

Sample Code

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "=Page_Title", "tags").Get();

Sample Response from executing Code

<tags count="3" href="http://deki-hayes/@api/deki/pages/31/tags">
    <tag value="text tag">
        <title>text tag</title> 
    <tag value="date:2007-08-29">
        <title>Wednesday, August 29, 2007</title> 
    <tag value="define:this tag is a define">
        <title>this tag is a define</title> 
        <related count="1">
            <page id="29" href="http://deki-hayes/@api/deki/pages/29">
                <title>DekiWiki (Hayes)</title> 
                <path /> 

Curl Code Sample: Retrieve Page Tags

The following command retrieves a list of tags attached to page "foo":

Sample Code

curl -u username:password -i http://mindtouch.address/@api/deki/pages/=foo/tags

Sample Response from executing Code

Sample response of running the command on a page with two tags:

Content-Type: application/xml

<tags count="2" href="">
  <tag value="awesome" id="10" href="">
  <tag value="real cool" id="11" href="">
    <title>real cool</title>

Implementation notes 

curl flags

Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
Outputs the HTTP response headers. Useful for debugging.


To view a list of all pages, follow the instructions here.
  • Was this article helpful?