Get a specific tag header

GET /tagheaders/{id}
OAuth2

Return a specific tag header. Limited to those the user can see

Path parameters

  • id integer Required

    Which item to be processed

    Minimum value is 0.

Responses

  • 200 application/json

    List returned OK

    Hide response attributes Show response attributes object
    • id integer

      Minimum value is 1.

    • name string
    • tags array[object]
      Hide tags attributes Show tags attributes object
      • id integer

        Minimum value is 1.

      • header_id integer

        Minimum value is 1.

      • name string
      • public integer

        Whether this is a public (1) or private tag (0)

        Minimum value is 0, maximum value is 1.

      • order integer

        The order this code appears in the list

        Minimum value is 0.

    • order integer

      The order this code appears in the list

      Minimum value is 0.
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
GET /tagheaders/{id} 
curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/tagheaders/99 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 123,
    "name": "Tag A",
    "tags": [
      {
        "id": 123,
        "header_id": 123,
        "name": "Tag A",
        "public": 1,
        "order": 1
      }
    ],
    "order": 1
  }
]
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}
Response examples (404) 
{
  "error": "Not Found"
}