Roadtrippers Developer Hub

Welcome to the Roadtrippers Developer Hub. You'll find comprehensive guides and documentation to help you start working with Roadtrippers as quickly as possible, as well as support if you get stuck. Let's jump right in!

Custom Tags

Users can manage their own set of tags that can be applied to their place records.

/api/v2/tags/:tag_id

Fetch tag data selected by the tag id value.

Returns

status: 200

Example Result

{
  "data": {
    "id": 34,
    "name": "American Food",
    "source_id": 592,
    "source_item_id": "60993",
    "parent_tag_id": null,
    "internal": true,
    "other_attrs": {
      "proprietary": 42
    },
    "canonical_tag_id": null,
    "statistics": {
      "places_count": 36,
      "canonical_places_count": 24
    }
  } 
}

/api/v2/tags

Create a new tag.

Accepts

{
    "name": "Barbecue",
  "source_id": 42,
  "source_item_id": 6,
  "parent_tag_id": 1,
  "internal": true,
  "other_attrs": {
    "Southern": true 
  }
}

Returns

status: 200

Example Result

{
  "data": {
    "id": 34,
    "name": "Barbecue",
    "source_id": 42,
    "source_item_id": 6,
    "parent_tag_id": 1,
    "internal": true,
    "other_attrs": {
      "Southern": true 
    },
    "canonical_tag_id": null,
    "statistics": null
  } 
}

/api/v2/tags/:tag_id

Update your existing tag record.

Accepts

{
    "name": "Barbecue",
  "source_id": 42,
  "source_item_id": 6,
  "parent_tag_id": 1,
  "internal": true,
  "other_attrs": {
    "Southern": true 
  }
}

Returns

status: 204

/api/v2/tags/:tag_id

Deletes a place record.

Returns

status: 204

/api/v2/tags

Returns all of your available tags.

Returns

status: 200

Example Results

{
  "data": [
    {
      "name": "Barbecue",
      "source_id": 42,
      "source_item_id": 6,
      "parent_tag_id": 1,
      "internal": true,
      "other_attrs": {
        "Southern": true 
      },
      "statistics": {
        "places_count": 36,
        "canonical_places_count": 24
      }
    }
  ]
}

Data formats

tag

NameTypeRequired?Description
idintegerNoDatabase ID of the tag.
source_item_idintegerYesSource item ID of the tag.
namestringYesReadable name for the tag.
internalbooleanYesWhether or not the tag is visible to other organizations.
enabledbooleanNoWhether or not the tag can be utilized.
other_attrsjsonNoExtra attributes describing the tag.
canonical_tag_idintegerNoCanonical tag corresponding to this tag.

Updated about a year ago

Custom Tags


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.