SocialOS | Documentation

Suggest Edits

get

Get coin details.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/coin
curl --request GET \
  --url 'https://app.test.socialos.io/coins/coin?coin=coin'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/coin',
  qs: { coin: 'coin' } };

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

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

url = URI("https://app.test.socialos.io/coins/coin?coin=coin")

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
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://app.test.socialos.io/coins/coin?coin=coin");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/coin"

querystring = {"coin":"coin"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The coin ID.

Response

Success.

Not a valid ID.

Coin not found.

 
Suggest Edits

get

Get wallet details, balances, and contents.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/wallet
curl --request GET \
  --url 'https://app.test.socialos.io/coins/wallet?wallet=wallet'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/wallet',
  qs: { wallet: 'wallet' } };

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

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

url = URI("https://app.test.socialos.io/coins/wallet?wallet=wallet")

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
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://app.test.socialos.io/coins/wallet?wallet=wallet");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/wallet"

querystring = {"wallet":"wallet"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

wallet
string
required

The wallet ID or address.

Response

Success.

Not a valid ID.

Wallet not found.

 
Suggest Edits

get

Get coin or user history.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/history
curl --request GET \
  --url https://app.test.socialos.io/coins/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/history' };

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

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

url = URI("https://app.test.socialos.io/coins/history")

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
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://app.test.socialos.io/coins/history");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/history"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

user
string

User ID or address.

action
string

The action type.

Response

Success.

Not a valid ID.

Coin not found.

 
Suggest Edits

post

Export wallet contents to blockchain.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/export
curl --request POST \
  --url 'https://app.test.socialos.io/coins/export?wallet=wallet'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/export',
  qs: { wallet: 'wallet' } };

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

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

url = URI("https://app.test.socialos.io/coins/export?wallet=wallet")

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
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://app.test.socialos.io/coins/export?wallet=wallet");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/export"

querystring = {"wallet":"wallet"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

wallet
string
required

The wallet ID or address.

Response

Success.

Not a valid ID.

Wallet not found.

Suggest Edits

get

Get history of coins given.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/given
curl --request GET \
  --url https://app.test.socialos.io/coins/given
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/given' };

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

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

url = URI("https://app.test.socialos.io/coins/given")

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
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://app.test.socialos.io/coins/given");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/given"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

user
string

User ID or address.

Response

Success.

Not a valid ID.

Coin not found.

 
Suggest Edits

post

Import wallet contents to blockchain.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/import
curl --request POST \
  --url 'https://app.test.socialos.io/coins/import?wallet=wallet'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/import',
  qs: { wallet: 'wallet' } };

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

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

url = URI("https://app.test.socialos.io/coins/import?wallet=wallet")

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
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://app.test.socialos.io/coins/import?wallet=wallet");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/import"

querystring = {"wallet":"wallet"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

wallet
string
required

The wallet ID or address.

Response

Success.

Not a valid ID.

Wallet not found.

Suggest Edits

get

List coins.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/coins
curl --request GET \
  --url 'https://app.test.socialos.io/coins/coins?count=1&page=1'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/coins',
  qs: 
   { count: '1',
     page: '1' } };

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

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

url = URI("https://app.test.socialos.io/coins/coins?count=1&page=1")

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
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://app.test.socialos.io/coins/coins?count=1&page=1");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/coins"

querystring = {"count":"1","page":"1"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Query Params

user
string

The address or ID of the owner of the coins.

creator
string

The address or ID of the issuer of the coins.

wallet
integer

The ID of the wallet containing the coins.

currency
string

The currency ID of the coins.

symbol
string

The symbol of the coin batch.

count
integer
required

Number of results to return.

page
integer
required

Number of results to return.

Response

Success.

Not a valid address or ID.

User not found.

 
Suggest Edits

get

List wallets.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/wallets
curl --request GET \
  --url 'https://app.test.socialos.io/coins/wallets?count=1&page=1'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/wallets',
  qs: 
   { count: '1',
     page: '1' } };

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

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

url = URI("https://app.test.socialos.io/coins/wallets?count=1&page=1")

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
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://app.test.socialos.io/coins/wallets?count=1&page=1");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/wallets"

querystring = {"count":"1","page":"1"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Query Params

owner
string

The address or ID of the owner of the wallets.

owners
string

A list of addresses or IDs of the owners of the wallets.

addresses
string

A list of addresses or IDs of the wallets.

count
integer
required

Number of results to return.

page
integer
required

Number of results to return.

Response

Success.

Not a valid address or ID.

User not found.

Suggest Edits

post

Create an API wallet and optionally link a blockchain wallet.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/open
curl --request POST \
  --url 'https://app.test.socialos.io/coins/open?name=name'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/open',
  qs: { name: 'name' } };

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

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

url = URI("https://app.test.socialos.io/coins/open?name=name")

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
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://app.test.socialos.io/coins/open?name=name");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/open"

querystring = {"name":"name"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

name
string
required

Wallet name.

source
string

Blockchain wallet source.

address
string

Blockchain wallet address.

Response

Success.

Not a valid address.

Source not found.

Suggest Edits

/transfer

 
Suggest Edits

post

Transfer a coin to any available platform.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/transfer
curl --request POST \
  --url 'https://app.test.socialos.io/coins/transfer?platform=platform&address=address'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/transfer',
  qs: 
   { platform: 'platform',
     address: 'address' } };

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

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

url = URI("https://app.test.socialos.io/coins/transfer?platform=platform&address=address")

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
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://app.test.socialos.io/coins/transfer?platform=platform&address=address");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/transfer"

querystring = {"platform":"platform","address":"address"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

wallet
string

The address or ID of the wallet.

platform
string
required

The target platform, such as email, SMS, or Twitter.

address
string
required

The users address on the platform platform.

hours
integer

The number of hours to hold the coin before returning to sender.

text
string

An optional text message. Length limits may apply when sending to an external platform.

Response

Success.

Not a valid address or ID.

Not your coin.

Wallet not found.

 
Suggest Edits

post

Add a payload to an existing coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/supply
curl --request POST \
  --url 'https://app.test.socialos.io/coins/supply?coin=coin&payload=payload'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/supply',
  qs: 
   { coin: 'coin',
     payload: 'payload' } };

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

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

url = URI("https://app.test.socialos.io/coins/supply?coin=coin&payload=payload")

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
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://app.test.socialos.io/coins/supply?coin=coin&payload=payload");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/supply"

querystring = {"coin":"coin","payload":"payload"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

payload
string
required

The payload.

Response

Success.

Not your coin.

Coin not found.

 
Suggest Edits

post

Consume a payload from an existing coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/consume
curl --request POST \
  --url 'https://app.test.socialos.io/coins/consume?coin=coin'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/consume',
  qs: { coin: 'coin' } };

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

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

url = URI("https://app.test.socialos.io/coins/consume?coin=coin")

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
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://app.test.socialos.io/coins/consume?coin=coin");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/consume"

querystring = {"coin":"coin"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Add a wrapper to an existing coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/wrap
curl --request POST \
  --url 'https://app.test.socialos.io/coins/wrap?coin=coin&wrapper=wrapper'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/wrap',
  qs: 
   { coin: 'coin',
     wrapper: 'wrapper' } };

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

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

url = URI("https://app.test.socialos.io/coins/wrap?coin=coin&wrapper=wrapper")

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
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://app.test.socialos.io/coins/wrap?coin=coin&wrapper=wrapper");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/wrap"

querystring = {"coin":"coin","wrapper":"wrapper"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

wrapper
string
required

The wrapper.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Split an existing coin into multiple lower value coins.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/split
curl --request POST \
  --url 'https://app.test.socialos.io/coins/split?coin=coin'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/split',
  qs: { coin: 'coin' } };

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

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

url = URI("https://app.test.socialos.io/coins/split?coin=coin")

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
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://app.test.socialos.io/coins/split?coin=coin");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/split"

querystring = {"coin":"coin"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

split
integer

Number of resulting coins.

value
number

Value of resulting coins.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Merge multiple existing coin into a single higher value coins.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/merge
curl --request POST \
  --url 'https://app.test.socialos.io/coins/merge?coin=coin&coins=coins'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/merge',
  qs: 
   { coin: 'coin',
     coins: 'coins' } };

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

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

url = URI("https://app.test.socialos.io/coins/merge?coin=coin&coins=coins")

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
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://app.test.socialos.io/coins/merge?coin=coin&coins=coins");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/merge"

querystring = {"coin":"coin","coins":"coins"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the target coin.

coins
string
required

The IDs of the coins to be merged.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Mint a batch of coins.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/mint
curl --request POST \
  --url 'https://app.test.socialos.io/coins/mint?name=name&value=value&count=count'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/mint',
  qs: 
   { name: 'name',
     value: 'value',
     count: 'count' } };

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

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

url = URI("https://app.test.socialos.io/coins/mint?name=name&value=value&count=count")

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
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://app.test.socialos.io/coins/mint?name=name&value=value&count=count");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/mint"

querystring = {"name":"name","value":"value","count":"count"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

name
string
required

The name of the new coin.

value
number
required

The face value of the coins.

count
integer
required

The number of coins to create.

front
string

The image on the front (obverse/head) of the coin.

back
string

The image on the back (reverse/tail) of the coin.

payload
string

An optional payload.

wrapper
string

An optional wrapper.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Sell a coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/sell
curl --request POST \
  --url 'https://app.test.socialos.io/coins/sell?coin=coin&price=price'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/sell',
  qs: 
   { coin: 'coin',
     price: 'price' } };

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

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

url = URI("https://app.test.socialos.io/coins/sell?coin=coin&price=price")

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
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://app.test.socialos.io/coins/sell?coin=coin&price=price");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/sell"

querystring = {"coin":"coin","price":"price"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

price
number
required

Price.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Buy a coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/buy
curl --request POST \
  --url 'https://app.test.socialos.io/coins/buy?coin=coin'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/buy',
  qs: { coin: 'coin' } };

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

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

url = URI("https://app.test.socialos.io/coins/buy?coin=coin")

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
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://app.test.socialos.io/coins/buy?coin=coin");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/buy"

querystring = {"coin":"coin"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

Response

Success.

Not your coin.

Coin not found.

 
Suggest Edits

post

Auction a coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/auction
curl --request POST \
  --url 'https://app.test.socialos.io/coins/auction?mode=mode&coin=coin&start=start'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/auction',
  qs: 
   { mode: 'mode',
     coin: 'coin',
     start: 'start' } };

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

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

url = URI("https://app.test.socialos.io/coins/auction?mode=mode&coin=coin&start=start")

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
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://app.test.socialos.io/coins/auction?mode=mode&coin=coin&start=start");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/auction"

querystring = {"mode":"mode","coin":"coin","start":"start"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

mode
string
required

Auction mode - either normal or reverse.

coin
string
required

The ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

reserve
number

The reserve price for standard auctions. If this is not met, the auction will fail.

maximum
number

The maximum (starting) price for reverse auctions.

minimum
number

The minimum (ending) price for reverse auctions.

start
integer
required

The start time for the auction.

end
integer

The end time for the auction.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

post

Bid on an auction.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/bid
curl --request POST \
  --url 'https://app.test.socialos.io/coins/bid?auction=auction&price=price'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/bid',
  qs: 
   { auction: 'auction',
     price: 'price' } };

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

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

url = URI("https://app.test.socialos.io/coins/bid?auction=auction&price=price")

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
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://app.test.socialos.io/coins/bid?auction=auction&price=price");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/bid"

querystring = {"auction":"auction","price":"price"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

auction
string
required

The ID of the auction.

price
number
required

Price.

Response

Success.

Not your coin.

Coin not found.

 
Suggest Edits

post

Cancel a sale or auction.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/cancel
curl --request POST \
  --url https://app.test.socialos.io/coins/cancel
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/cancel' };

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

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

url = URI("https://app.test.socialos.io/coins/cancel")

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
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://app.test.socialos.io/coins/cancel");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/cancel"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

auction
string

The ID of the auction.

sale
string

The ID of the sale.

text
string

An optional text message explaining the cancellation.

Response

Success.

Not your coin.

Coin not found.

Suggest Edits

/auctions

 
Suggest Edits

get

List auctions.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/auctions
curl --request GET \
  --url 'https://app.test.socialos.io/coins/auctions?count=1&page=1'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/auctions',
  qs: 
   { count: '1',
     page: '1' } };

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

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

url = URI("https://app.test.socialos.io/coins/auctions?count=1&page=1")

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
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://app.test.socialos.io/coins/auctions?count=1&page=1");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/auctions"

querystring = {"count":"1","page":"1"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Query Params

user
string

The address or ID of the owner of the auction.

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

currency
string

The currency ID of the coins being auctioned.

count
integer
required

Number of results to return.

page
integer
required

Number of results to return.

Response

Success.

Not a valid address or ID.

User not found.

Suggest Edits

get

List sales.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/sales
curl --request GET \
  --url 'https://app.test.socialos.io/coins/sales?count=1&page=1'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/sales',
  qs: 
   { count: '1',
     page: '1' } };

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

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

url = URI("https://app.test.socialos.io/coins/sales?count=1&page=1")

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
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://app.test.socialos.io/coins/sales?count=1&page=1");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/sales"

querystring = {"count":"1","page":"1"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Query Params

user
string

The address or ID of the seller.

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

currency
string

The currency ID of the coins being sold.

name
string

The name of the coins being sold.

count
integer
required

Number of results to return.

page
integer
required

Number of results to return.

Response

Success.

Not a valid address or ID.

User not found.

 
Suggest Edits

post

Request a coin.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://app.test.socialos.io/coins/request
curl --request POST \
  --url 'https://app.test.socialos.io/coins/request?coin=coin&wallet=wallet'
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.test.socialos.io/coins/request',
  qs: 
   { coin: 'coin',
     wallet: 'wallet' } };

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

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

url = URI("https://app.test.socialos.io/coins/request?coin=coin&wallet=wallet")

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
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://app.test.socialos.io/coins/request?coin=coin&wallet=wallet");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/request"

querystring = {"coin":"coin","wallet":"wallet"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Query Params

coin
string
required

The ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

wallet
number
required

Target wallet.

text
string

Optional text message.

Response

Success.

Coin not found.

Suggest Edits

/requests

 
Suggest Edits

get

List requests.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://app.test.socialos.io/coins/requests
curl --request GET \
  --url 'https://app.test.socialos.io/coins/requests?count=1&page=1'
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.test.socialos.io/coins/requests',
  qs: 
   { count: '1',
     page: '1' } };

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

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

url = URI("https://app.test.socialos.io/coins/requests?count=1&page=1")

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
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://app.test.socialos.io/coins/requests?count=1&page=1");

xhr.send(data);
import requests

url = "https://app.test.socialos.io/coins/requests"

querystring = {"count":"1","page":"1"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Query Params

user
string

The address or ID of the requesting user.

sender
string

The address or ID of the sender.

coin
integer

The numeric ID of the coin.

uuid
string

The UUID of the coin.

symbol
string

The symbol of the coin batch.

sequence
string

The sequence of the coin within the batch.

currency
string

The currency ID of the coins being sold.

name
string

The name of the coins being sold.

count
integer
required

Number of results to return.

page
integer
required

Number of results to return.

Response

Success.

Not a valid address or ID.

User not found.

Suggest Edits

/classes/{classname}

 
Suggest Edits

post

Create a class

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/classes/classname
curl --request POST \
  --url https://parse.test.socialos.io/api/classes/classname
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/classes/classname' };

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

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

url = URI("https://parse.test.socialos.io/api/classes/classname")

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
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://parse.test.socialos.io/api/classes/classname");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/classes/classname"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

classname
string
required

Class name

Response

OK

Suggest Edits

/classes/{classname}/{objectid}

 
Suggest Edits

get

Fetch object

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/classes/classname/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/classes/classname/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/classes/classname/objectid")

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
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://parse.test.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/classes/classname/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

classname
string
required

Class name

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update object

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/classes/classname/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/classes/classname/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/classes/classname/objectid")

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
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://parse.test.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/classes/classname/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

classname
string
required

Class name

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete object

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/classes/classname/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/classes/classname/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/classes/classname/objectid")

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
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://parse.test.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/classes/classname/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

classname
string
required

Class name

objectid
string
required

Object ID

Response

OK

Suggest Edits

get

Query users

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/users
curl --request GET \
  --url https://parse.test.socialos.io/api/users
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/users' };

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

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

url = URI("https://parse.test.socialos.io/api/users")

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
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://parse.test.socialos.io/api/users");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Sign up or link users

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/users
curl --request POST \
  --url https://parse.test.socialos.io/api/users
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/users' };

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

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

url = URI("https://parse.test.socialos.io/api/users")

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
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://parse.test.socialos.io/api/users");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/users/{objectid}

 
Suggest Edits

get

Retrieve user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/users/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/users/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/users/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/users/objectid")

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
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://parse.test.socialos.io/api/users/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/users/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/users/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/users/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/users/objectid")

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
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://parse.test.socialos.io/api/users/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/users/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/users/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/users/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/users/objectid")

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
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://parse.test.socialos.io/api/users/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

/users/me

 
Suggest Edits

get

Retrieve current user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/users/me
curl --request GET \
  --url https://parse.test.socialos.io/api/users/me
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/users/me' };

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

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

url = URI("https://parse.test.socialos.io/api/users/me")

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
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://parse.test.socialos.io/api/users/me");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/users/me"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/sessions

 
Suggest Edits

get

Query sessions

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/sessions
curl --request GET \
  --url https://parse.test.socialos.io/api/sessions
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/sessions' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions")

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
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://parse.test.socialos.io/api/sessions");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Create restricted sessions

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/sessions
curl --request POST \
  --url https://parse.test.socialos.io/api/sessions
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/sessions' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions")

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
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://parse.test.socialos.io/api/sessions");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/sessions/{objectid}

 
Suggest Edits

get

Retrieve session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/sessions/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/sessions/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/sessions/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions/objectid")

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
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://parse.test.socialos.io/api/sessions/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/sessions/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/sessions/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/sessions/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions/objectid")

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
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://parse.test.socialos.io/api/sessions/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/sessions/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/sessions/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/sessions/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions/objectid")

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
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://parse.test.socialos.io/api/sessions/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

/sessions/me

 
Suggest Edits

get

Retrieve current session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/sessions/me
curl --request GET \
  --url https://parse.test.socialos.io/api/sessions/me
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/sessions/me' };

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

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

url = URI("https://parse.test.socialos.io/api/sessions/me")

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
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://parse.test.socialos.io/api/sessions/me");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/sessions/me"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Create roles

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/roles
curl --request POST \
  --url https://parse.test.socialos.io/api/roles
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/roles' };

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

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

url = URI("https://parse.test.socialos.io/api/roles")

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
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://parse.test.socialos.io/api/roles");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/roles"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/roles/{objectid}

 
Suggest Edits

get

Retrieve role

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/roles/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/roles/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/roles/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/roles/objectid")

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
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://parse.test.socialos.io/api/roles/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/roles/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update role

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/roles/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/roles/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/roles/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/roles/objectid")

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
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://parse.test.socialos.io/api/roles/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/roles/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete role

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/roles/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/roles/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/roles/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/roles/objectid")

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
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://parse.test.socialos.io/api/roles/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/roles/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

/installations

 
Suggest Edits

get

Query installations

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/installations
curl --request GET \
  --url https://parse.test.socialos.io/api/installations
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/installations' };

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

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

url = URI("https://parse.test.socialos.io/api/installations")

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
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://parse.test.socialos.io/api/installations");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/installations"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Create restricted installations

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/installations
curl --request POST \
  --url https://parse.test.socialos.io/api/installations
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/installations' };

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

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

url = URI("https://parse.test.socialos.io/api/installations")

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
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://parse.test.socialos.io/api/installations");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/installations"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/installations/{objectid}

 
Suggest Edits

get

Retrieve session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/installations/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/installations/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/installations/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/installations/objectid")

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
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://parse.test.socialos.io/api/installations/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/installations/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/installations/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/installations/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/installations/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/installations/objectid")

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
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://parse.test.socialos.io/api/installations/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/installations/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/installations/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/installations/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/installations/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/installations/objectid")

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
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://parse.test.socialos.io/api/installations/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/installations/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

 
Suggest Edits

get

Query schemas

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/schemas
curl --request GET \
  --url https://parse.test.socialos.io/api/schemas
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/schemas' };

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

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

url = URI("https://parse.test.socialos.io/api/schemas")

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
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://parse.test.socialos.io/api/schemas");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/schemas"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Create restricted schemas

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/schemas
curl --request POST \
  --url https://parse.test.socialos.io/api/schemas
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/schemas' };

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

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

url = URI("https://parse.test.socialos.io/api/schemas")

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
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://parse.test.socialos.io/api/schemas");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/schemas"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/schemas/{objectid}

 
Suggest Edits

get

Retrieve session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/schemas/objectid
curl --request GET \
  --url https://parse.test.socialos.io/api/schemas/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/schemas/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/schemas/objectid")

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
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://parse.test.socialos.io/api/schemas/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/schemas/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

put

Update session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/schemas/objectid
curl --request PUT \
  --url https://parse.test.socialos.io/api/schemas/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/schemas/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/schemas/objectid")

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
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://parse.test.socialos.io/api/schemas/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/schemas/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete session

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/schemas/objectid
curl --request DELETE \
  --url https://parse.test.socialos.io/api/schemas/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/schemas/objectid' };

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

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

url = URI("https://parse.test.socialos.io/api/schemas/objectid")

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
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://parse.test.socialos.io/api/schemas/objectid");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/schemas/objectid"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

objectid
string
required

Object ID

Response

OK

Suggest Edits

/hooks/functions

 
Suggest Edits

get

Query cloud functions

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/hooks/functions
curl --request GET \
  --url https://parse.test.socialos.io/api/hooks/functions
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/hooks/functions' };

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

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

url = URI("https://parse.test.socialos.io/api/hooks/functions")

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
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://parse.test.socialos.io/api/hooks/functions");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/hooks/functions"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

post

Create cloud fiunctions

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/hooks/functions
curl --request POST \
  --url https://parse.test.socialos.io/api/hooks/functions
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/hooks/functions' };

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

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

url = URI("https://parse.test.socialos.io/api/hooks/functions")

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
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://parse.test.socialos.io/api/hooks/functions");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/hooks/functions"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/hooks/functions/{function}

 
Suggest Edits

get

Retrieve cloud function

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://parse.test.socialos.io/api/hooks/functions/function
curl --request GET \
  --url https://parse.test.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.test.socialos.io/api/hooks/functions/function' };

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

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

url = URI("https://parse.test.socialos.io/api/hooks/functions/function")

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
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://parse.test.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/hooks/functions/function"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

function
string
required

Object ID

Response

OK

Suggest Edits

put

Update cloud function

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://parse.test.socialos.io/api/hooks/functions/function
curl --request PUT \
  --url https://parse.test.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.test.socialos.io/api/hooks/functions/function' };

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

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

url = URI("https://parse.test.socialos.io/api/hooks/functions/function")

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
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://parse.test.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/hooks/functions/function"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

function
string
required

Object ID

Response

OK

Suggest Edits

delete

Delete cloud function

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://parse.test.socialos.io/api/hooks/functions/function
curl --request DELETE \
  --url https://parse.test.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.test.socialos.io/api/hooks/functions/function' };

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

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

url = URI("https://parse.test.socialos.io/api/hooks/functions/function")

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
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://parse.test.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/hooks/functions/function"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

function
string
required

Object ID

Response

OK

Suggest Edits

post

Log in

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/login
curl --request POST \
  --url https://parse.test.socialos.io/api/login
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/login' };

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

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

url = URI("https://parse.test.socialos.io/api/login")

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
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://parse.test.socialos.io/api/login");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/login"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

 
Suggest Edits

post

Log out

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/logout
curl --request POST \
  --url https://parse.test.socialos.io/api/logout
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/logout' };

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

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

url = URI("https://parse.test.socialos.io/api/logout")

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
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://parse.test.socialos.io/api/logout");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/logout"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/requestpasswordreset

 
Suggest Edits

post

Reset password

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://parse.test.socialos.io/api/requestpasswordreset
curl --request POST \
  --url https://parse.test.socialos.io/api/requestpasswordreset
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.test.socialos.io/api/requestpasswordreset' };

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

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

url = URI("https://parse.test.socialos.io/api/requestpasswordreset")

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
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://parse.test.socialos.io/api/requestpasswordreset");

xhr.send(data);
import requests

url = "https://parse.test.socialos.io/api/requestpasswordreset"

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

OK

Suggest Edits

/{address}

 
Suggest Edits

get

Get user by address.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.test.socialos.io/user/address
curl --request GET \
  --url https://api.test.socialos.io/user/address
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.test.socialos.io/user/address' };

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

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

url = URI("https://api.test.socialos.io/user/address")

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
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.test.socialos.io/user/address");

xhr.send(data);
import requests

url = "https://api.test.socialos.io/user/address"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Path Params

address
string
required

The full address of the user, in the form name@domain.

Response

Success.

Not a valid address or ID.

User not found.

Suggest Edits

get

Activate user (admin only).

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.test.socialos.io/user/ID
curl --request GET \
  --url https://api.test.socialos.io/user/ID
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.test.socialos.io/user/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.test.socialos.io/user/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
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.test.socialos.io/user/ID");

xhr.send(data);
import requests

url = "https://api.test.socialos.io/user/ID"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Path Params

ID
string
required

The record ID of the user.

Response

Success.

Not a valid address or ID.

Access denied.

User not found.

Suggest Edits

put

Update user data, replacing sub-objects.

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.test.socialos.io/user/ID
curl --request PUT \
  --url https://api.test.socialos.io/user/ID
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.test.socialos.io/user/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.test.socialos.io/user/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
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.test.socialos.io/user/ID");

xhr.send(data);
import requests

url = "https://api.test.socialos.io/user/ID"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Path Params

ID
string
required

The record ID of the user.

Response

Success.

Not a valid address or ID.

Access denied.

User not found.

Suggest Edits

delete

Delete a user and their data.

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.test.socialos.io/user/ID
curl --request DELETE \
  --url https://api.test.socialos.io/user/ID
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.test.socialos.io/user/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.test.socialos.io/user/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
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.test.socialos.io/user/ID");

xhr.send(data);
import requests

url = "https://api.test.socialos.io/user/ID"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Path Params

ID
string
required

The record ID of the user.

Response

Success.

Not a valid address or ID.

Access denied.

User not found.

Suggest Edits

patch

Update user data, updating sub-objects.

 

Basic Auth

 Authentication is required for this endpoint.
patchhttps://api.test.socialos.io/user/ID
curl --request PATCH \
  --url https://api.test.socialos.io/user/ID
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.test.socialos.io/user/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.test.socialos.io/user/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
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.test.socialos.io/user/ID");

xhr.send(data);
import requests

url = "https://api.test.socialos.io/user/ID"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

undefined

Path Params

ID
string
required

The record ID of the user.

Response

Success.

Not a valid address or ID.

Access denied.

User not found.

Suggest Edits

/list/{ID}