List Tags

GET https://api.yonoma.io/v1/tags/list

Send GET request to this end point to list all of your tags.

Code Samples

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer YOUR_API_KEY");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://api.yonoma.io/v1/tags/list", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));


const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.yonoma.io/v1/tags/list',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer YOUR_API_KEY'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});


var settings = {
  "url": "https://api.yonoma.io/v1/tags/list",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});


var xhr = new XMLHttpRequest();

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.yonoma.io/v1/tags/list");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer YOUR_API_KEY");

xhr.send();


var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'api.yonoma.io',
  'path': '/v1/tags/list',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();


var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.yonoma.io/v1/tags/list',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});


var unirest = require('unirest');
var req = unirest('GET', 'https://api.yonoma.io/v1/tags/list')
  .headers({
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  })
  .end(function (res) { 
    if (res.error) throw new Error(res.error); 
    console.log(res.raw_body);
  });

Copy

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api.yonoma.io/v1/tags/list")
  .method("GET", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer YOUR_API_KEY")
  .build();
Response response = client.newCall(request).execute();


Unirest.setTimeouts(0, 0);
HttpResponse response = Unirest.get("https://api.yonoma.io/v1/tags/list")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer YOUR_API_KEY")
  .asString();


package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.yonoma.io/v1/tags/list"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer YOUR_API_KEY")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.yonoma.io/v1/tags/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_API_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer YOUR_API_KEY'
];
$request = new Request('GET', 'https://api.yonoma.io/v1/tags/list', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();


import http.client

conn = http.client.HTTPSConnection("api.yonoma.io")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_API_KEY'
}
conn.request("GET", "/v1/tags/list", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))


import requests
import json

url = "https://api.yonoma.io/v1/tags/list"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)


require "uri"
require "json"
require "net/http"

url = URI("https://api.yonoma.io/v1/tags/list")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer YOUR_API_KEY"

response = https.request(request)
puts response.read_body

Responses
HTTP Code : 200 Content Type : JSON
Data Schema Example

statusCode string required

HTTP status code

status string required

Success status

data object required

tag_id string

The ID of the tag

tag_name string

The name of the tag


{
    "statusCode":200,
    "status": "Success",
    "data": [
        {
            "tag_id": "ZUSYCRNHKV",
            "tag_name": "Open"
        },
        {
            "tag_id": "BGNGZK1RQQ",
            "tag_name": "Close"
        }
    ]
}

HTTP Code : 400 Content Type : JSON
Data Schema Example

statusCode string optional

HTTP status code

status string optional

Error status

message string optional

Description of the error message


{
    "statusCode": 400,
    "status": "Error",
    "message": "Please provide valid tag id!",
    "data": {}
}

HTTP Code : 401 Content Type : JSON
Data Schema Example

statusCode string optional

HTTP status code

status string optional

Error status

message string optional

Description of the error message


{
    "statusCode": 401,
    "status": "Error",
    "message": "Please send valid apikey in header!",
    "data": {}
}

HTTP Code : 500 Content Type : JSON
Data Schema Example

statusCode string optional

HTTP status code

status string optional

Error status

message string optional

Description of the error message


{
    "statusCode": 500,
    "status": "Error",
    "message": "Sorry! Something went wrong.",
    "data": {}
}

Too many requests hit the API too quickly.