3Blades

Suggest Edits

Introduction

 

3Blades currently offers a HTTP REST API which is used by both the Web UI and the CLI Tools. This API documentation contains all API operations currently supported in the platform and provides examples of how to execute them using our Command Line Interface (CLI), Python SDK and Go SDK.

Authentication

In order to make requests to the 3Blades API, you will need a JSON Web Token (JWT) for your account. Generate a JWT by providing a valid username and password to the /auth/jwt-token-auth/ endpoint. Once you generate your JWT, include the Authorization header in each API request. The value of the Authorization header should be in the following format: Bearer YOURJWT.

Code Samples

Code samples do not include headers. Add Content-Type and Authorization headers to your code. The interactive API prompts the user to add their valid JWT token after clicking on the Try It option. Content-Type header is included automatically.

RESTful API

The 3Blades REST API is reachable through the following hostname:

https://api.3blades.ai/

All requests should be sent to this endpoint using basic authentication using a valid authentication token. All endpoints are versioned except for the auth endpoints.

Namespaced Endpoints

Endpoints that are labeled as namespaced allow users to operate over different account/projects, for example a over a specific user project. The namespace includes the user or team account + project name, since it is possible for two accounts to have a project with the same name. A namespace therefore identifies the full project path.

Example:

The user foo wants to manage a file within a specific project. They can use either of the following urls: https://api.3blades.io/v1/foo/my-proyect/my-file.

Namespaced Endpoints in the 3Blades CLI

If you are using namespaces with the 3Blades CLI, set them by changing the value of the TBS_NAMESPACE environment variable. In *nix environments you can eval $(tbs env --namespace foo/myproject) into your namespace. For more information please view CLI Tools README.

Suggest Edits

Create JSON Web Token (JWT)

 
posthttps://api.3blades.ai/auth/jwt-token-auth/
curl --request POST \
  --url https://api.3blades.ai/auth/jwt-token-auth/
import requests

url = "https://api.3blades.ai/auth/jwt-token-auth/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/auth/jwt-token-auth/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/auth/jwt-token-auth/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/auth/jwt-token-auth/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/auth/jwt-token-auth/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/auth/jwt-token-auth/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/auth/jwt-token-auth/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/auth/jwt-token-auth/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/auth/jwt-token-auth/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
}

Body Params

username
string
required

User name.

password
string
required

User password.

Response

JWT created

tokenstring

Unique JSON Web Token (JWT).

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

usernamearray

username field errors

passwordarray

password field errors

tokenarray

token field errors

Suggest Edits

Refresh a JSON Web Token (JWT)

Obtains a new JSON Web Token using existing user credentials.

 
posthttps://api.3blades.ai/auth/jwt-token-refresh/
curl --request POST \
  --url https://api.3blades.ai/auth/jwt-token-refresh/
import requests

url = "https://api.3blades.ai/auth/jwt-token-refresh/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/auth/jwt-token-refresh/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/auth/jwt-token-refresh/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/auth/jwt-token-refresh/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/auth/jwt-token-refresh/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/auth/jwt-token-refresh/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/auth/jwt-token-refresh/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/auth/jwt-token-refresh/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/auth/jwt-token-refresh/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

token
string
required

Refreshed token.

Response

RefreshJSONWebToken created

tokenstring

Refresh JWT token.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field.

tokenarray

Token field errors.

Suggest Edits

Validate JSON Web Token (JWT)

Checks veraciy of token.

 
posthttps://api.3blades.ai/auth/jwt-token-verify/
curl --request POST \
  --url https://api.3blades.ai/auth/jwt-token-verify/
import requests

url = "https://api.3blades.ai/auth/jwt-token-verify/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/auth/jwt-token-verify/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/auth/jwt-token-verify/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/auth/jwt-token-verify/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/auth/jwt-token-verify/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/auth/jwt-token-verify/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/auth/jwt-token-verify/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/auth/jwt-token-verify/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/auth/jwt-token-verify/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
}

Body Params

token
string
required

JSON Web Token (JWT).

Response

VerifyJSONWebToken created

tokenstring

Varify JWT token.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field.

tokenarray

Token field errors.

Suggest Edits

/auth/login/{provider}/

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/auth/login/provider/
curl --request GET \
  --url https://api.3blades.ai/auth/login/provider/
import requests

url = "https://api.3blades.ai/auth/login/provider/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/auth/login/provider/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/auth/login/provider/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/auth/login/provider/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/auth/login/provider/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/auth/login/provider/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/auth/login/provider/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/auth/login/provider/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/auth/login/provider/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

provider
string
required

OAuth2 provider

Response

Redirect to backend auth page

Suggest Edits

Register a user

User registration requires confirming email address to activate user.

 
posthttps://api.3blades.ai/auth/register/
curl --request POST \
  --url https://api.3blades.ai/auth/register/
import requests

url = "https://api.3blades.ai/auth/register/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/auth/register/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST', url: 'https://api.3blades.ai/auth/register/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/auth/register/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/auth/register/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/auth/register/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/auth/register/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/auth/register/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/auth/register/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "id": "536686d7-0096-4c72-a4c3-5d710a361a0a",
  "username": "johndoe",
  "email": "user@email.com",
  "first_name": "John",
  "last_name": "Doe",
  "profile": {
    "avatar_url": "http://example.com/",
    "bio": "I like tests",
    "url": "http://about.me/myprofile",
    "location": "Atlanta, GA",
    "company": "3Blades",
    "timezone": "America/New_York"
  }
}

Body Params

username
string
required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

email
string

User email.

first_name
string

User first name.

last_name
string

User last name.

password
string
required

User password.

profile
object
required

User profile information is required, although attribute values may be empty.

 
profile.avatar
byte

Avatar image

profile.bio
string

Description of user's biography.

profile.url
string

Users's personal website.

profile.location
string

User location.

profile.company
string

User's company.

profile.timezone
string

User's time zone.

Response

User created

idstring

User unique identifier, expressed as UUID.

usernamestring

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

emailstring

User email address.

first_namestring

User first name.

last_namestring

User last name.

profileobject

User profile information.

profile.avatarstring

Avatar image

profile.biostring

Description of user's biography.

profile.urlstring

Users's personal website.

profile.locationstring

User location.

profile.companystring

User's company.

profile.timezonestring

User's time zone.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field.

idarray

id field errors.

usernamearray

Username field errors.

emailarray

Email field errors.

first_namearray

First name field errors.

last_namearray

Last name field errors.

passwordarray

Password field errors.

profileobject
profile.non_field_errorsarray

Errors not connected to any field.

profile.bioarray

Bio field errors.

profile.urlarray

URL field errors.

profile.locationarray

Location field errors.

profile.companyarray

Company field errors.

profile.timezonearray

Timezone field errors.

 
Suggest Edits

Get credit cards

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/cards/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/cards/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/cards/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Path Params

namespace
string
required

User or team name.

Query Params

limit
string

Set limit when retrieving credit or debit cards.

offset
string

Set offset when retriving cards.

ordering
string

Order when retrieving cards.

Response

Card list

Suggest Edits

Create new credit card

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.3blades.ai/v1/namespace/billing/cards/
curl --request POST \
  --url https://api.3blades.ai/v1/namespace/billing/cards/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/v1/namespace/billing/cards/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "name": "John Doe",
  "address_line1": "3423 Piedmont Rd NE",
  "address_line2": "",
  "address_city": "Atlanta",
  "address_state": "Georgia",
  "address_zip": "30305",
  "address_country": "United States",
  "exp_month": 1,
  "exp_year": 2019,
  "id": "4126086e-525a-4027-b9e7-ae8de47210b2",
  "customer": "7e102c7b-55cd-49a0-9b23-58865eba1cc3",
  "address_line1_check": "pass",
  "address_zip_check": "pass",
  "brand": "Visa",
  "cvc_check": "",
  "last4": "4242",
  "fingerprint": "WpZ4zQymdmF5LhbH",
  "funding": "credit",
  "stripe_id": "card_1Aj8HuLUHPUzUsaQlDbaXjzA",
  "created": "2017-07-24T15:16:07.995380Z"
}

Path Params

namespace
string
required

User or team name.

Body Params

name
string

Card name.

address_line1
string

Address line 1.

address_line2
string

Address line 2.

address_city
string

Address city.

address_state
string

Address state.

address_zip
string

Address zip code.

address_country
string

Address country.

exp_month
integer

Card expiration month.

exp_year
integer

Card expiration year.

token
string

Card unique token.

Response

Card created

namestring

Card name.

address_line1string

Address line 1.

address_line2string

Address line 2.

address_citystring

Address city.

address_statestring

Address state.

address_zipstring

Address zip code.

address_countrystring

Address country.

exp_monthinteger

Card expiration month.

exp_yearinteger

Card expiration year.

tokenstring

Card unique token.

idstring

Card unique identifier, expressed as UUID.

customerstring

Card customer.

address_line1_checkstring

Address line 1 check, when processing card.

address_zip_checkstring

Address check, when processing card.

brandstring

Credit or debit card brand.

cvc_checkstring

Security code check.

last4string

Last four digits of credit or debit card.

fingerprintstring

Card fingerprint.

fundingstring

Funding.

stripe_idstring

Unique stripe identifier.

createdstring

Card date and time creation.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

namearray

name field errors

address_line1array

address_line1 field errors

address_line2array

address_line2 field errors

address_cityarray

address_city field errors

address_statearray

address_state field errors

address_ziparray

address_zip field errors

address_countryarray

address_country field errors

exp_montharray

exp_month field errors

exp_yeararray

exp_year field errors

tokenarray

token field errors

idarray

id field errors

customerarray

customer field errors

address_line1_checkarray

address_line1_check field errors

address_zip_checkarray

address_zip_check field errors

brandarray

brand field errors

cvc_checkarray

cvc_check field errors

last4array

last4 field errors

fingerprintarray

fingerprint field errors

fundingarray

funding field errors

stripe_idarray

stripe_id field errors

createdarray

created field errors

Suggest Edits

Get credit card by id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/cards/id/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/cards/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/id/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/cards/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/id/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/id/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/id/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/id/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "name": "John Doe",
  "address_line1": "3423 Piedmont Rd NE",
  "address_line2": "",
  "address_city": "Atlanta",
  "address_state": "Georgia",
  "address_zip": "30305",
  "address_country": "United States",
  "exp_month": 1,
  "exp_year": 2019,
  "id": "4126086e-525a-4027-b9e7-ae8de47210b2",
  "customer": "7e102c7b-55cd-49a0-9b23-58865eba1cc3",
  "address_line1_check": "pass",
  "address_zip_check": "pass",
  "brand": "Visa",
  "cvc_check": "",
  "last4": "4242",
  "fingerprint": "WpZ4zQymdmF5LhbH",
  "funding": "credit",
  "stripe_id": "card_1Aj8HuLUHPUzUsaQlDbaXjzA",
  "created": "2017-07-24T15:16:07.995380Z"
}

Path Params

namespace
string
required

User or team name.

id
string
required

User unique identifier expressed as UUID.

Response

Card retrieved.

namestring

Card name.

address_line1string

Address line 1.

address_line2string

Address line 2.

address_citystring

Address city.

address_statestring

Address state.

address_zipstring

Address zip code.

address_countrystring

Address country.

exp_monthinteger

Card expiration month.

exp_yearinteger

Card expiration year.

tokenstring

Card unique token.

idstring

Card unique identifier, expressed as UUID.

customerstring

Card customer.

address_line1_checkstring

Address line 1 check, when processing card.

address_zip_checkstring

Address check, when processing card.

brandstring

Credit or debit card brand.

cvc_checkstring

Security code check.

last4string

Last four digits of credit or debit card.

fingerprintstring

Card fingerprint.

fundingstring

Funding.

stripe_idstring

Unique stripe identifier.

createdstring

Card date and time creation.

Card not found.

detailstring

Requested item not found.

Suggest Edits

Replace a credit card

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.3blades.ai/v1/namespace/billing/cards/id/
curl --request PUT \
  --url https://api.3blades.ai/v1/namespace/billing/cards/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/id/"

response = requests.request("PUT", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PUT", "https://api.3blades.ai/v1/namespace/billing/cards/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/id/")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/id/"

	req, _ := http.NewRequest("PUT", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/id/");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/id/")
  .put(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "name": "John Doe",
  "address_line1": "3423 Piedmont Rd NE",
  "address_line2": "",
  "address_city": "Atlanta",
  "address_state": "Georgia",
  "address_zip": "30305",
  "address_country": "United States",
  "exp_month": 1,
  "exp_year": 2027,
  "id": "4126086e-525a-4027-b9e7-ae8de47210b2",
  "customer": "7e102c7b-55cd-49a0-9b23-58865eba1cc3",
  "address_line1_check": "pass",
  "address_zip_check": "pass",
  "brand": "Visa",
  "cvc_check": "",
  "last4": "4242",
  "fingerprint": "WpZ4zQymdmF5LhbH",
  "funding": "credit",
  "stripe_id": "card_1Aj8HuLUHPUzUsaQlDbaXjzA",
  "created": "2017-07-24T15:16:07.995380Z"
}

Path Params

namespace
string
required

User or team name.

id
string
required

Body Params

name
string

Card name.

address_line1
string

Address line 1.

address_line2
string

Address line 2.

address_city
string

Address city.

address_state
string

Address state.

address_zip
string

Address zip code.

address_country
string

Address country.

exp_month
integer

Card expiration month.

exp_year
integer

Card expiration year.

Response

Card updated

namestring

Card name.

address_line1string

Address line 1.

address_line2string

Address line 2.

address_citystring

Address city.

address_statestring

Address state.

address_zipstring

Address zip code.

address_countrystring

Address country.

exp_monthinteger

Card expiration month.

exp_yearinteger

Card expiration year.

tokenstring

Card unique token.

idstring

Card unique identifier, expressed as UUID.

customerstring

Card customer.

address_line1_checkstring

Address line 1 check, when processing card.

address_zip_checkstring

Address check, when processing card.

brandstring

Credit or debit card brand.

cvc_checkstring

Security code check.

last4string

Last four digits of credit or debit card.

fingerprintstring

Card fingerprint.

fundingstring

Funding.

stripe_idstring

Unique stripe identifier.

createdstring

Card date and time creation.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

namearray

name field errors

address_line1array

address_line1 field errors

address_line2array

address_line2 field errors

address_cityarray

address_city field errors

address_statearray

address_state field errors

address_ziparray

address_zip field errors

address_countryarray

address_country field errors

exp_montharray

exp_month field errors

exp_yeararray

exp_year field errors

tokenarray

token field errors

idarray

id field errors

customerarray

customer field errors

address_line1_checkarray

address_line1_check field errors

address_zip_checkarray

address_zip_check field errors

brandarray

brand field errors

cvc_checkarray

cvc_check field errors

last4array

last4 field errors

fingerprintarray

fingerprint field errors

fundingarray

funding field errors

stripe_idarray

stripe_id field errors

createdarray

created field errors

Suggest Edits

Update a credit card

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/billing/cards/id/
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/billing/cards/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/id/"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/billing/cards/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/id/")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/id/"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/id/");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/id/")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "name": "John Doe",
  "address_line1": "3423 Piedmont Rd NE",
  "address_line2": "",
  "address_city": "Atlanta",
  "address_state": "Georgia",
  "address_zip": "30305",
  "address_country": "United States",
  "exp_month": 1,
  "exp_year": 2025,
  "id": "4126086e-525a-4027-b9e7-ae8de47210b2",
  "customer": "7e102c7b-55cd-49a0-9b23-58865eba1cc3",
  "address_line1_check": "pass",
  "address_zip_check": "pass",
  "brand": "Visa",
  "cvc_check": "",
  "last4": "4242",
  "fingerprint": "WpZ4zQymdmF5LhbH",
  "funding": "credit",
  "stripe_id": "card_1Aj8HuLUHPUzUsaQlDbaXjzA",
  "created": "2017-07-24T15:16:10.806003Z"
}

Path Params

namespace
string
required

User or team name.

id
string
required

Card unique identifier.

Body Params

name
string

Card name.

address_line1
string

Address line 1.

address_line2
string

Address line 2.

address_city
string

Address city.

address_state
string

Address state.

address_zip
string

Address zip code.

address_country
string

Address country.

exp_month
integer

Card expiration month.

exp_year
integer

Card expiration year.

Response

Card updated

namestring

Card name.

address_line1string

Address line 1.

address_line2string

Address line 2.

address_citystring

Address city.

address_statestring

Address state.

address_zipstring

Address zip code.

address_countrystring

Address country.

exp_monthinteger

Card expiration month.

exp_yearinteger

Card expiration year.

tokenstring

Card unique token.

idstring

Card unique identifier, expressed as UUID.

customerstring

Card customer.

address_line1_checkstring

Address line 1 check, when processing card.

address_zip_checkstring

Address check, when processing card.

brandstring

Credit or debit card brand.

cvc_checkstring

Security code check.

last4string

Last four digits of credit or debit card.

fingerprintstring

Card fingerprint.

fundingstring

Funding.

stripe_idstring

Unique stripe identifier.

createdstring

Card date and time creation.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

namearray

name field errors

address_line1array

address_line1 field errors

address_line2array

address_line2 field errors

address_cityarray

address_city field errors

address_statearray

address_state field errors

address_ziparray

address_zip field errors

address_countryarray

address_country field errors

exp_montharray

exp_month field errors

exp_yeararray

exp_year field errors

tokenarray

token field errors

idarray

id field errors

customerarray

customer field errors

address_line1_checkarray

address_line1_check field errors

address_zip_checkarray

address_zip_check field errors

brandarray

brand field errors

cvc_checkarray

cvc_check field errors

last4array

last4 field errors

fingerprintarray

fingerprint field errors

fundingarray

funding field errors

stripe_idarray

stripe_id field errors

createdarray

created field errors

Card not found

detailstring

Requested item not found.

Suggest Edits

Delete a credit card

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.3blades.ai/v1/namespace/billing/cards/id/
curl --request DELETE \
  --url https://api.3blades.ai/v1/namespace/billing/cards/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/cards/id/"

response = requests.request("DELETE", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("DELETE", "https://api.3blades.ai/v1/namespace/billing/cards/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.3blades.ai/v1/namespace/billing/cards/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/cards/id/")

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

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/cards/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/cards/id/"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/cards/id/");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/cards/id/")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/cards/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

id
string
required

Card unique identifier expressed as UUID.

Response

Card deleted.

Card not found.

detailstring

Requested item not found.

Suggest Edits

Get invoices

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/invoices/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/invoices/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/invoices/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/invoices/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/invoices/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/invoices/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/invoices/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/invoices/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/invoices/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/invoices/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/invoices/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Path Params

namespace
string
required

User or team name.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

Response

Invoice list.

Suggest Edits

Get an invoice

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/invoices/id/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/invoices/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/invoices/id/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/invoices/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/invoices/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/invoices/id/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/invoices/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/invoices/id/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/invoices/id/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/invoices/id/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/invoices/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

id
string
required

Invoice unique identifier expressed as UUID.

Response

Invoice retrieved.

idstring

Invoice unique identifier expressed as UUID.

stripe_idstring

Stripe account identifier.

createdstring

Date and time when invoice was created.

metadataobject

Optional metadata object of invoice.

livemodeboolean

Boolean that determines whether invoice is live, or not.

amount_dueinteger

Amount due set in invoice.

application_feeinteger

Application fee set in invoice.

attempt_countinteger

Number of attempts to deliver invoice.

attemptedboolean

Boolean to determine whether delivery attempt executed, or not.

closedboolean

Invoice closed, or pending.

currencystring

Currency used in invoice.

invoice_datestring

Invoice issue date.

descriptionstring

Invoice description.

next_payment_attemptstring

Next payment attempt.

paidboolean

Determines whether invoice has been paid, or not.

period_startstring

Invoice start period.

period_endstring

Invoice end period.

reciept_numberstring

Invoice receipt number.

starting_balanceinteger

Invoice starting balance.

statement_descriptorstring

Invoice statement descriptor.

subtotalinteger

Invoice sub total.

taxinteger

Tax, if applicable.

totalinteger

Invoice total.

customerstring

Customer name.

subscriptionstring

Suscription name.

Invoice not found.

detailstring

Requested item not found.

Suggest Edits

Get invoice items for a given invoice.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Path Params

namespace
string
required

User or team name.

invoice_id
string
required

Invoice id, expressed as UUID.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

Response

InvoiceItem list.

Suggest Edits

Get a specific InvoiceItem.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id
import requests

url = "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/invoices/invoice_id/invoice-items/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

invoice_id
string
required

Invoice id, expressed as UUID.

id
string
required

InvoiceItem id, expressed as UUID.

Response

InvoiceItem retrieved.

idstring

InvoiceItem unique identifier expressed as UUID.

stripe_idstring

Stripe account identifier.

createdstring

Date and time when invoice was created.

metadataobject

Optional metadata object of invoice.

livemodeboolean

Boolean that determines whether invoice is live, or not.

invoicestring

Invoice unique identifier expressed as UUID.

amountinteger

Amount the the invoice item will be billed for.

currencystring

Currency used in invoice.

invoice_datestring

Date the item was added to the invoice.

prorationboolean

Whether or not the items cost will be prorated for the billing period.

quantityinteger

Number of units for this item.

descriptionstring

Item description.

InvoiceItem not found.

detailstring

Requested item not found.

Suggest Edits

Get billing plans

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/plans/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/plans/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/plans/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/plans/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/plans/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/plans/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/plans/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/plans/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/plans/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/plans/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/plans/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "d5791ab3-aefb-45af-80fc-2c7a166d78eb",
    "stripe_id": "post_billing_plan",
    "created": "2017-07-24T15:46:39Z",
    "metadata": {},
    "livemode": false,
    "amount": 20,
    "currency": "usd",
    "interval": "year",
    "interval_count": 1,
    "name": "patch_billing_plan",
    "statement_descriptor": "",
    "trial_period_days": 7
  },
  {
    "id": "256fd63a-9d6b-48d2-8ff5-f56eaf54c59b",
    "stripe_id": "post_billing_plan_2",
    "created": "2017-07-24T15:46:48Z",
    "metadata": {},
    "livemode": false,
    "amount": 20,
    "currency": "usd",
    "interval": "week",
    "interval_count": 52,
    "name": "post_billing_plan_2",
    "statement_descriptor": "",
    "trial_period_days": 7
  },
  {
    "id": "5915a2ae-12f5-4927-bb26-3b0609228791",
    "stripe_id": "post_billing_plan_3",
    "created": "2017-07-24T15:46:52Z",
    "metadata": {},
    "livemode": false,
    "amount": 20,
    "currency": "usd",
    "interval": "month",
    "interval_count": 12,
    "name": "post_billing_plan_3",
    "statement_descriptor": "",
    "trial_period_days": 7
  }
]

Path Params

namespace
string
required

User or team name.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

Response

Plan list.

Suggest Edits

Get a billing plan

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/plans/id/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/plans/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/plans/id/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/plans/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/plans/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/plans/id/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/plans/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/plans/id/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/plans/id/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/plans/id/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/plans/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "id": "d5791ab3-aefb-45af-80fc-2c7a166d78eb",
  "stripe_id": "post_billing_plan",
  "created": "2017-07-24T15:46:39Z",
  "metadata": {},
  "livemode": false,
  "amount": 20,
  "currency": "usd",
  "interval": "year",
  "interval_count": 1,
  "name": "post_billing_plan",
  "statement_descriptor": "",
  "trial_period_days": 7
}

Path Params

namespace
string
required

User or team name.

id
string
required

Plan unique identifier expressed as UUID.

Response

Plan retrieved

idstring

Plan unique identifier as UUID.

stripe_idstring

Stripe identifier to identify entity charging for plans.

createdstring

Date and time when plan was created.

metadataobject

Optional meta data object.

livemodeboolean

Boolean to determine whether plan is live, or not.

amountinteger

Amount (cost/price) of plan.

currencystring

Currency used to specify amount.

intervalstring

Interval for plan, such as montly or yearly.

interval_countinteger
namestring

Plan name.

statement_descriptorstring

Statement that describes plan to users.

trial_period_daysinteger

Number of days for plan trial, used for try and buy campaigns.

Plan not found

detailstring

Requested item not found.

Suggest Edits

Get active subscriptons

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/subscriptions/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/subscriptions/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/subscriptions/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/subscriptions/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/subscriptions/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/subscriptions/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/subscriptions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/subscriptions/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/subscriptions/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/subscriptions/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/subscriptions/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "579208c3-4f5c-4b5d-baa3-309a06db681c",
    "plan": "efb36cb0-0ef2-4af3-ae5d-10d9ae73845d",
    "stripe_id": "sub_B5KyO9BZ6lUNPP",
    "created": "2017-07-24T17:25:04Z",
    "livemode": false,
    "application_fee_percent": 0,
    "cancel_at_period_end": false,
    "canceled_at": "",
    "current_period_start": "2017-07-24T17:25:04Z",
    "current_period_end": "2017-07-31T17:25:04Z",
    "start": "2017-07-24T17:25:04Z",
    "ended_at": "",
    "quantity": 1,
    "status": "trialing",
    "trial_start": "2017-07-24T17:25:04Z",
    "trial_end": "2017-07-31T17:25:04Z"
  }
]

Path Params

namespace
string
required

User or team name.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

Response

Subscription list.

Suggest Edits

Create a new subscription

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.3blades.ai/v1/namespace/billing/subscriptions/
curl --request POST \
  --url https://api.3blades.ai/v1/namespace/billing/subscriptions/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/subscriptions/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/v1/namespace/billing/subscriptions/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/v1/namespace/billing/subscriptions/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/subscriptions/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/subscriptions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/subscriptions/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/subscriptions/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/subscriptions/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/subscriptions/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

{
  "id": "579208c3-4f5c-4b5d-baa3-309a06db681c",
  "plan": "efb36cb0-0ef2-4af3-ae5d-10d9ae73845d",
  "stripe_id": "sub_B5KyO9BZ6lUNPP",
  "created": "2017-07-24T17:25:04Z",
  "livemode": false,
  "application_fee_percent": 0,
  "cancel_at_period_end": false,
  "canceled_at": "",
  "current_period_start": "2017-07-24T17:25:04Z",
  "current_period_end": "2017-07-31T17:25:04Z",
  "start": "2017-07-24T17:25:04Z",
  "ended_at": "",
  "quantity": 1,
  "status": "trialing",
  "trial_start": "2017-07-24T17:25:04Z",
  "trial_end": "2017-07-31T17:25:04Z"
}

Path Params

namespace
string
required

User or team name.

Body Params

plan
string
required

Plan unique identifier.

Response

Subscription created

idstring

Unique identifier for suscription as UUID.

planstring

Plan name.

stripe_idstring

Stripe (payment processor) identifier.

createdstring

Date and time suscription was created.

livemodeboolean

Suscription live, or not.

application_fee_percentnumber

Application fee percent.

cancel_at_period_endboolean

Boolean value to determine whether plan cancels at the end of the period, or not.

canceled_atstring

Date and time when plan was cancelled.

current_period_startstring

Current suscription plan start date.

current_period_endstring

Current suscription plan end date.

startstring

Date and time for when plan started.

ended_atstring

Date and time for when plan ended.

quantityinteger

Quantity purchased as integer.

statusstring

Suscription status.

trial_startstring

Date and time for trial start.

trial_endstring

Date and time for trial end.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

idarray

id field errors

planarray

plan field errors

stripe_idarray

stripe_id field errors

createdarray

created field errors

livemodearray

livemode field errors

application_fee_percentarray

application_fee_percent field errors

cancel_at_period_endarray

cancel_at_period_end field errors

canceled_atarray

canceled_at field errors

current_period_startarray

current_period_start field errors

current_period_endarray

current_period_end field errors

startarray

start field errors

ended_atarray

ended_at field errors

quantityarray

quantity field errors

statusarray

status field errors

trial_startarray

trial_start field errors

trial_endarray

trial_end field errors

Suggest Edits

Get a subscriptions

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/billing/subscriptions/id/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/billing/subscriptions/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/billing/subscriptions/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

id
string
required

Unique identifier expressed as UUID.

Response

Subscription retrieved.

idstring

Unique identifier for suscription as UUID.

planstring

Plan name.

stripe_idstring

Stripe (payment processor) identifier.

createdstring

Date and time suscription was created.

livemodeboolean

Suscription live, or not.

application_fee_percentnumber

Application fee percent.

cancel_at_period_endboolean

Boolean value to determine whether plan cancels at the end of the period, or not.

canceled_atstring

Date and time when plan was cancelled.

current_period_startstring

Current suscription plan start date.

current_period_endstring

Current suscription plan end date.

startstring

Date and time for when plan started.

ended_atstring

Date and time for when plan ended.

quantityinteger

Quantity purchased as integer.

statusstring

Suscription status.

trial_startstring

Date and time for trial start.

trial_endstring

Date and time for trial end.

Subscription not found.

detailstring

Requested item not found.

Suggest Edits

Delete a subscription

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.3blades.ai/v1/namespace/billing/subscriptions/id/
curl --request DELETE \
  --url https://api.3blades.ai/v1/namespace/billing/subscriptions/id/
import requests

url = "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/"

response = requests.request("DELETE", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("DELETE", "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/");

xhr.send(data);
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.3blades.ai/v1/namespace/billing/subscriptions/id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")

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

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/billing/subscriptions/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

id
string
required

Subscription unique identifier expressed as UUID.

Response

Subscription deleted.

Subscription not found.

detailstring

Requested item not found.

Suggest Edits

Get available hosts

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/hosts/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/hosts/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/hosts/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/hosts/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

Query Params

limit
string

Limite when getting items.

offset
string

Offset when getting items.

name
string

Name, when getting items.

ordering
string

Ordering when getting items.

Response

DockerHost list.

Suggest Edits

Create a new host

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.3blades.ai/v1/namespace/hosts/
curl --request POST \
  --url https://api.3blades.ai/v1/namespace/hosts/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/v1/namespace/hosts/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/v1/namespace/hosts/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

Body Params

name
string
required

DockerHost name.

ip
string
required

DockerHost IPv4 address.

port
integer

DockerHost port.

Response

DockerHost created successfully.

idstring

Unique identifier for docker host as UUID.

namestring

Docker host name.

ipstring

Docker host IPv4 address

portinteger

Docker host port.

statusstring

Docker host status.

Invalid data supplied.

non_field_errorsarray

Errors not connected to any field.

idarray

Id field errors.

namearray

Name field errors.

iparray

Ip field errors

portarray

Port field errors.

statusarray

Status field errors.

Suggest Edits

Get a host

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/hosts/host/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/hosts/host/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/host/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/hosts/host/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/hosts/host/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/host/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/host/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/host/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/host/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/host/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/host/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

host
string
required

Unique identifier expressed as UUID or name.

Response

DockerHost retrieved.

idstring

Unique identifier for docker host as UUID.

namestring

Docker host name.

ipstring

Docker host IPv4 address

portinteger

Docker host port.

statusstring

Docker host status.

DockerHost not found.

detailstring

Requested item not found.

Suggest Edits

Replace a host

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.3blades.ai/v1/namespace/hosts/host/
curl --request PUT \
  --url https://api.3blades.ai/v1/namespace/hosts/host/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/host/"

response = requests.request("PUT", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PUT", "https://api.3blades.ai/v1/namespace/hosts/host/");

xhr.send(data);
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.3blades.ai/v1/namespace/hosts/host/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/host/")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/host/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/host/"

	req, _ := http.NewRequest("PUT", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/host/");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/host/")
  .put(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/host/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

host
string
required

Body Params

name
string
required

DockerHost name.

ip
string
required

DockerHost IPv4 address.

port
integer

DockerHost port.

Response

DockerHost updated.

idstring

Unique identifier for docker host as UUID.

namestring

Docker host name.

ipstring

Docker host IPv4 address

portinteger

Docker host port.

statusstring

Docker host status.

Invalid data supplied.

non_field_errorsarray

Errors not connected to any field.

idarray

Id field errors.

namearray

Name field errors.

iparray

Ip field errors

portarray

Port field errors.

statusarray

Status field errors.

Suggest Edits

Update a host

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/hosts/host/
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/hosts/host/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/host/"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/hosts/host/");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/hosts/host/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/host/")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/host/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/host/"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/host/");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/host/")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/host/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

host
string
required

Body Params

name
string
required

DockerHost name.

ip
string
required

DockerHost IPv4 address.

port
integer

DockerHost port.

Response

DockerHost updated

idstring

Unique identifier for docker host as UUID.

namestring

Docker host name.

ipstring

Docker host IPv4 address

portinteger

Docker host port.

statusstring

Docker host status.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field.

idarray

Id field errors.

namearray

Name field errors.

iparray

Ip field errors

portarray

Port field errors.

statusarray

Status field errors.

DockerHost not found

detailstring

Requested item not found.

Suggest Edits

Delete a host

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.3blades.ai/v1/namespace/hosts/host/
curl --request DELETE \
  --url https://api.3blades.ai/v1/namespace/hosts/host/
import requests

url = "https://api.3blades.ai/v1/namespace/hosts/host/"

response = requests.request("DELETE", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("DELETE", "https://api.3blades.ai/v1/namespace/hosts/host/");

xhr.send(data);
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.3blades.ai/v1/namespace/hosts/host/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/hosts/host/")

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

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/hosts/host/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/hosts/host/"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/hosts/host/");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/hosts/host/")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/hosts/host/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

host
string
required

DockerHost unique identifier expressed as UUID.

Response

DockerHost deleted.

DockerHost not found.

detailstring

Requested item not found.

Suggest Edits

notifications

 
Suggest Edits

Get notifications of all types and entities for the authenticated user.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/notifications/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/notifications/
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/notifications/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/notifications/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

read
boolean

When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread.

Response

List of notifications

Suggest Edits

Mark a list of notifications as either read or unread.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/notifications/
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/notifications/
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/notifications/");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/notifications/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

Body Params

notifications
array of strings
required

An array of notification IDs to update.

read
boolean
required

Mark the notification as either read or unread

Response

Notification updated

idstring

Notification unique identifier expressed as a UUID

actorstring

Unique identifier of the object that triggered the notification.

targetstring

Unique identifier of the object that was acted upon by the object referred to in actor.

typestring

Type of the notification, e.g. invoice.created, subscription.created, etc.

timestampstring

Timestamp that the notification was created at.

readboolean

Whether or not the notification has been marked as read by the user.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

readarray

read field errors

Suggest Edits

Get notifications of all types and entities for the authenticated user.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/notifications/entity/entity
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/notifications/entity/entity
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/entity/entity"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/notifications/entity/entity");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/notifications/entity/entity' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/entity/entity")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/entity/entity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/entity/entity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/entity/entity");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/entity/entity")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/entity/entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

entity
string
required

Entity to filter notifications by.

Query Params

limit
string

Limit when getting items.

offset
string

Offset when getting items.

ordering
string

Ordering when getting items.

read
boolean

When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread.

Response

List of notifications

Suggest Edits

Mark a list of notifications as either read or unread.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/notifications/entity/entity
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/notifications/entity/entity
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/entity/entity"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/notifications/entity/entity");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/notifications/entity/entity' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/entity/entity")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/entity/entity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/entity/entity"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/entity/entity");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/entity/entity")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/entity/entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

entity
string
required

Entity to filter notifications by.

Body Params

notifications
array of strings
required

An array of notification IDs to update.

read
boolean
required

Mark the notification as either read or unread

Response

Notification updated

idstring

Notification unique identifier expressed as a UUID

actorstring

Unique identifier of the object that triggered the notification.

targetstring

Unique identifier of the object that was acted upon by the object referred to in actor.

typestring

Type of the notification, e.g. invoice.created, subscription.created, etc.

timestampstring

Timestamp that the notification was created at.

readboolean

Whether or not the notification has been marked as read by the user.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

readarray

read field errors

Suggest Edits

Retrieve a specific notification.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/notifications/notification_id
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/notifications/notification_id
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/notification_id"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/notifications/notification_id");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/notifications/notification_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/notification_id")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/notification_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/notification_id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/notification_id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/notification_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/notification_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

notification_id
string
required

Notification UUID.

Response

Retrieve a notification.

idstring

Notification unique identifier expressed as a UUID

actorstring

Unique identifier of the object that triggered the notification.

targetstring

Unique identifier of the object that was acted upon by the object referred to in actor.

typestring

Type of the notification, e.g. invoice.created, subscription.created, etc.

timestampstring

Timestamp that the notification was created at.

readboolean

Whether or not the notification has been marked as read by the user.

Notification not found.

detailstring

Requested item not found.

Suggest Edits

Mark a specific notification as either read or unread.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/notifications/notification_id
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/notifications/notification_id
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/notification_id"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/notifications/notification_id");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/notifications/notification_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/notification_id")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/notification_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/notification_id"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/notification_id");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/notification_id")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/notification_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

notification_id
string
required

Notification UUID.

Body Params

read
boolean
required

Mark the notification as either read or unread

Response

Notification updated

idstring

Notification unique identifier expressed as a UUID

actorstring

Unique identifier of the object that triggered the notification.

targetstring

Unique identifier of the object that was acted upon by the object referred to in actor.

typestring

Type of the notification, e.g. invoice.created, subscription.created, etc.

timestampstring

Timestamp that the notification was created at.

readboolean

Whether or not the notification has been marked as read by the user.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

readarray

read field errors

Notification not found.

detailstring

Requested item not found.

Suggest Edits

Retrieve global notification settings for the authenticated user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/notifications/settings/
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/notifications/settings/
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/settings/"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/notifications/settings/");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/notifications/settings/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/settings/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/settings/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/settings/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/settings/");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/settings/")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/settings/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

Response

Global notification settings

Notification not found.

detailstring

Requested item not found.

Suggest Edits

Create global notification settings

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.3blades.ai/v1/namespace/notifications/settings/
curl --request POST \
  --url https://api.3blades.ai/v1/namespace/notifications/settings/
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/settings/"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/v1/namespace/notifications/settings/");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/v1/namespace/notifications/settings/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/settings/")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/settings/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/settings/"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/settings/");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/settings/")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/settings/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

Body Params

enabled
boolean
required

Turn notifications on or off entirely.

emails_enabled
boolean
required

Turn emails on or off.

Response

Global Notification Settings created successfully.

idstring

Notification unique identifier expressed as a UUID

entitystring

The entity type that the settings pertain to.

enabledboolean

Turn notifications on or off entirely.

emails_enabledboolean

Turn emails on or off.

Invalid data supplied.

non_field_errorsarray

Errors not connected to any field

enabledboolean

enabled field errors

emails_enabledboolean

emails_enabled field errors

Suggest Edits

Modify global notification settings.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.3blades.ai/v1/namespace/notifications/settings/
curl --request PATCH \
  --url https://api.3blades.ai/v1/namespace/notifications/settings/
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/settings/"

response = requests.request("PATCH", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("PATCH", "https://api.3blades.ai/v1/namespace/notifications/settings/");

xhr.send(data);
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.3blades.ai/v1/namespace/notifications/settings/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/settings/")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/settings/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/settings/"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/settings/");
var request = new RestRequest(Method.PATCH);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/settings/")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/settings/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

Body Params

enabled
boolean
required

Turn notifications on or off entirely.

emails_enabled
boolean
required

Turn emails on or off.

Response

Notification Settings updated

idstring

Notification unique identifier expressed as a UUID

entitystring

The entity type that the settings pertain to.

enabledboolean

Turn notifications on or off entirely.

emails_enabledboolean

Turn emails on or off.

Invalid data supplied

non_field_errorsarray

Errors not connected to any field

enabledboolean

enabled field errors

emails_enabledboolean

emails_enabled field errors

Notification Settings not found.

detailstring

Requested item not found.

Suggest Edits

Retrieve global notification settings for the authenticated user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.3blades.ai/v1/namespace/notifications/settings/entity/entity
curl --request GET \
  --url https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity"

response = requests.request("GET", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("GET", "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")
  .get()
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team data.

entity
string
required

Entity whose settings should be retrieved.

Response

Global notification settings

Notification not found.

detailstring

Requested item not found.

Suggest Edits

Create global notification settings

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.3blades.ai/v1/namespace/notifications/settings/entity/entity
curl --request POST \
  --url https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity
import requests

url = "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity"

response = requests.request("POST", url)

print(response.text)
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

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

xhr.open("POST", "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var client = new RestClient("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.3blades.ai/v1/namespace/notifications/settings/entity/entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

namespace
string
required

User or team name.

entity
string
required

Entity whose settings should be retrieved.

Body Params

enabled
boolean
required

Turn notifications on or off entirely.

emails_enabled
boolean
required

Turn emails on or off.

Response

Global Notification Settings created successfully.

idstring

Notification unique identifier expressed as a UUID

entitystring

The entity type that the settings pertain to.

enabledboolean

Turn notifications on or off entirely.

emails_enabledboolean

Turn emails on or off.

Invalid data supplied.

non_field_errorsarray

Errors not connected to any field

enabledboolean

enabled field errors

emails_enabledboolean

emails_enabled field errors

Suggest Edits

Modify global notification settings.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://