SocialOS

Suggest Edits

/classes/{classname}

 
Suggest Edits

post

Create a class

 

OAuth2 Auth

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

var options = { method: 'POST',
  url: 'https://parse.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.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.socialos.io/api/classes/classname");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/classes/classname/objectid
curl --request GET \
  --url https://parse.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.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.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.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/classes/classname/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.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.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.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/classes/classname/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/classes/classname/objectid
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.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.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.socialos.io/api/classes/classname/objectid");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users
curl --request GET \
  --url https://parse.socialos.io/api/users
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users
curl --request POST \
  --url https://parse.socialos.io/api/users
var request = require("request");

var options = { method: 'POST', url: 'https://parse.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.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.socialos.io/api/users");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users/objectid
curl --request GET \
  --url https://parse.socialos.io/api/users/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/users/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/users/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/users/me
curl --request GET \
  --url https://parse.socialos.io/api/users/me
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions
curl --request GET \
  --url https://parse.socialos.io/api/sessions
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions
curl --request POST \
  --url https://parse.socialos.io/api/sessions
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.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.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.socialos.io/api/sessions");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions/objectid
curl --request GET \
  --url https://parse.socialos.io/api/sessions/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/sessions/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/sessions/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/sessions/me
curl --request GET \
  --url https://parse.socialos.io/api/sessions/me
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/roles
curl --request POST \
  --url https://parse.socialos.io/api/roles
var request = require("request");

var options = { method: 'POST', url: 'https://parse.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.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.socialos.io/api/roles");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/roles/objectid
curl --request GET \
  --url https://parse.socialos.io/api/roles/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/roles/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/roles/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/roles/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/roles/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/installations
curl --request GET \
  --url https://parse.socialos.io/api/installations
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/installations
curl --request POST \
  --url https://parse.socialos.io/api/installations
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.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.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.socialos.io/api/installations");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/installations/objectid
curl --request GET \
  --url https://parse.socialos.io/api/installations/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/installations/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/installations/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/installations/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/installations/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/schemas
curl --request GET \
  --url https://parse.socialos.io/api/schemas
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/schemas
curl --request POST \
  --url https://parse.socialos.io/api/schemas
var request = require("request");

var options = { method: 'POST', url: 'https://parse.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.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.socialos.io/api/schemas");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/schemas/objectid
curl --request GET \
  --url https://parse.socialos.io/api/schemas/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/schemas/objectid
curl --request PUT \
  --url https://parse.socialos.io/api/schemas/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/schemas/objectid
curl --request DELETE \
  --url https://parse.socialos.io/api/schemas/objectid
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/hooks/functions
curl --request GET \
  --url https://parse.socialos.io/api/hooks/functions
var request = require("request");

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

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/hooks/functions
curl --request POST \
  --url https://parse.socialos.io/api/hooks/functions
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.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.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.socialos.io/api/hooks/functions");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/hooks/functions/function
curl --request GET \
  --url https://parse.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'GET',
  url: 'https://parse.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.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.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/hooks/functions/function
curl --request PUT \
  --url https://parse.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'PUT',
  url: 'https://parse.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.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.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/hooks/functions/function
curl --request DELETE \
  --url https://parse.socialos.io/api/hooks/functions/function
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://parse.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.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.socialos.io/api/hooks/functions/function");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/login
curl --request POST \
  --url https://parse.socialos.io/api/login
var request = require("request");

var options = { method: 'POST', url: 'https://parse.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.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.socialos.io/api/login");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/logout
curl --request POST \
  --url https://parse.socialos.io/api/logout
var request = require("request");

var options = { method: 'POST', url: 'https://parse.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.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.socialos.io/api/logout");

xhr.send(data);
import requests

url = "https://parse.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.socialos.io/api/requestpasswordreset
curl --request POST \
  --url https://parse.socialos.io/api/requestpasswordreset
var request = require("request");

var options = { method: 'POST',
  url: 'https://parse.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.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.socialos.io/api/requestpasswordreset");

xhr.send(data);
import requests

url = "https://parse.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

/auth.test

 
Suggest Edits

get

Checks authentication and tells you who you are.

 

OAuth2 Auth

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

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/auth.test',
  qs: { token: 'token' } };

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

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

url = URI("https://slack.socialos.io/api/auth.test?token=token")

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://slack.socialos.io/api/auth.test?token=token");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/auth.test"

querystring = {"token":"token"}

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

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

token
string
required

Authentication token

Response

OK

okboolean
teamstring
team_idstring
urlstring
userstring
user_idstring
Suggest Edits

/channels.history

 
Suggest Edits

get

Fetches history of messages and events from a channel.

 
gethttps://slack.socialos.io/api/channels.history
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.history?channel=channel'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.history',
  qs: { channel: 'channel' } };

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

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

url = URI("https://slack.socialos.io/api/channels.history?channel=channel")

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://slack.socialos.io/api/channels.history?channel=channel");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.history"

querystring = {"channel":"channel"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

latest
string

Timestamp of the oldest recent seen message.

oldest
string

Timestamp of the latest previously seen message.

count
number

Number of messages to return, between 1 and 1000.

has_more
boolean
is_limited
boolean

Response

OK

has_moreboolean
lateststring
messagesarray
okboolean
Suggest Edits

/channels.info

 
Suggest Edits

get

Gets information about a channel.

 
gethttps://slack.socialos.io/api/channels.info
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.info?channel=channel'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.info',
  qs: { channel: 'channel' } };

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

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

url = URI("https://slack.socialos.io/api/channels.info?channel=channel")

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://slack.socialos.io/api/channels.info?channel=channel");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.info"

querystring = {"channel":"channel"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

Response

OK

channelobject
channel.creatednumber
channel.creatorstring
channel.idstring
channel.is_archivedboolean
channel.is_channelboolean
channel.is_generalboolean
channel.is_memberboolean
channel.last_readstring
channel.latestobject
channel.latest.attachmentsarray
channel.latest.textstring
channel.latest.tsstring
channel.latest.typestring
channel.latest.userstring
channel.membersarray
channel.namestring
channel.purposeobject
channel.purpose.creatorstring
channel.purpose.last_setnumber
channel.purpose.valuestring
channel.topicobject
channel.topic.creatorstring
channel.topic.last_setnumber
channel.topic.valuestring
channel.unread_countnumber
channel.unread_count_displaynumber
okboolean
Suggest Edits

/channels.invite

 
Suggest Edits

get

Invites a user to a channel.

 
gethttps://slack.socialos.io/api/channels.invite
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.invite?channel=channel&user=user'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.invite',
  qs: 
   { channel: 'channel',
     user: 'user' } };

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

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

url = URI("https://slack.socialos.io/api/channels.invite?channel=channel&user=user")

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://slack.socialos.io/api/channels.invite?channel=channel&user=user");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.invite"

querystring = {"channel":"channel","user":"user"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

user
string
required

User to invite to channel.

Response

OK

channelobject
channel.creatednumber
channel.creatorstring
channel.idstring
channel.is_archivedboolean
channel.is_channelboolean
channel.is_generalboolean
channel.is_memberboolean
channel.last_readstring
channel.latestobject
channel.latest.subtypestring
channel.latest.textstring
channel.latest.tsstring
channel.latest.typestring
channel.latest.userstring
channel.membersarray
channel.namestring
channel.purposeobject
channel.purpose.creatorstring
channel.purpose.last_setnumber
channel.purpose.valuestring
channel.topicobject
channel.topic.creatorstring
channel.topic.last_setnumber
channel.topic.valuestring
channel.unread_countnumber
channel.unread_count_displaynumber
okboolean
Suggest Edits

/channels.join

 
Suggest Edits

get

Joins a channel, creating it if needed.

 
gethttps://slack.socialos.io/api/channels.join
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.join?name=name'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.join',
  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://slack.socialos.io/api/channels.join?name=name")

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://slack.socialos.io/api/channels.join?name=name");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.join"

querystring = {"name":"name"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

name
string
required

Name of channel to join

Response

OK

channelobject
channel.creatednumber
channel.creatorstring
channel.idstring
channel.is_archivedboolean
channel.is_channelboolean
channel.is_generalboolean
channel.is_memberboolean
channel.last_readstring
channel.latestobject
channel.latest.subtypestring
channel.latest.textstring
channel.latest.tsstring
channel.latest.typestring
channel.latest.userstring
channel.membersarray
channel.namestring
channel.purposeobject
channel.purpose.creatorstring
channel.purpose.last_setnumber
channel.purpose.valuestring
channel.topicobject
channel.topic.creatorstring
channel.topic.last_setnumber
channel.topic.valuestring
channel.unread_countnumber
channel.unread_count_displaynumber
okboolean
Suggest Edits

/channels.leave

 
Suggest Edits

get

Leaves a channel.

 
gethttps://slack.socialos.io/api/channels.leave
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.leave?channel=channel'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.leave',
  qs: { channel: 'channel' } };

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

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

url = URI("https://slack.socialos.io/api/channels.leave?channel=channel")

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://slack.socialos.io/api/channels.leave?channel=channel");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.leave"

querystring = {"channel":"channel"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

Response

OK

okboolean
Suggest Edits

/channels.list

 
Suggest Edits

get

Lists all channels in a Slack team.

 
gethttps://slack.socialos.io/api/channels.list
curl --request GET \
  --url https://slack.socialos.io/api/channels.list
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.list' };

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

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

url = URI("https://slack.socialos.io/api/channels.list")

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://slack.socialos.io/api/channels.list");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.list"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

exclude_archived
string

Don't return archived channels.

Response

OK

channelsarray
okboolean
Suggest Edits

/channels.mark

 
Suggest Edits

get

Sets the read cursor in a channel.

 
gethttps://slack.socialos.io/api/channels.mark
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.mark?channel=channel&ts=ts'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.mark',
  qs: 
   { channel: 'channel',
     ts: 'ts' } };

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

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

url = URI("https://slack.socialos.io/api/channels.mark?channel=channel&ts=ts")

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://slack.socialos.io/api/channels.mark?channel=channel&ts=ts");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.mark"

querystring = {"channel":"channel","ts":"ts"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

ts
string
required

Timestamp of the most recently seen message.

Response

OK

okboolean
Suggest Edits

/channels.setPurpose

 
Suggest Edits

get

Sets the purpose for a channel.

 
gethttps://slack.socialos.io/api/channels.setPurpose
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.setPurpose?channel=channel&purpose=purpose'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.setPurpose',
  qs: 
   { channel: 'channel',
     purpose: 'purpose' } };

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

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

url = URI("https://slack.socialos.io/api/channels.setPurpose?channel=channel&purpose=purpose")

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://slack.socialos.io/api/channels.setPurpose?channel=channel&purpose=purpose");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.setPurpose"

querystring = {"channel":"channel","purpose":"purpose"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

purpose
string
required

The new purpose

Response

OK

okboolean
purposestring
Suggest Edits

/channels.setTopic

 
Suggest Edits

get

Sets the topic for a channel.

 
gethttps://slack.socialos.io/api/channels.setTopic
curl --request GET \
  --url 'https://slack.socialos.io/api/channels.setTopic?channel=channel&topic=topic'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/channels.setTopic',
  qs: 
   { channel: 'channel',
     topic: 'topic' } };

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

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

url = URI("https://slack.socialos.io/api/channels.setTopic?channel=channel&topic=topic")

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://slack.socialos.io/api/channels.setTopic?channel=channel&topic=topic");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/channels.setTopic"

querystring = {"channel":"channel","topic":"topic"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

topic
string
required

The new topic

Response

OK

okboolean
topicstring
Suggest Edits

/chat.delete

 
Suggest Edits

get

Deletes a message.

 
gethttps://slack.socialos.io/api/chat.delete
curl --request GET \
  --url 'https://slack.socialos.io/api/chat.delete?channel=channel&ts=ts'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/chat.delete',
  qs: 
   { channel: 'channel',
     ts: 'ts' } };

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

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

url = URI("https://slack.socialos.io/api/chat.delete?channel=channel&ts=ts")

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://slack.socialos.io/api/chat.delete?channel=channel&ts=ts");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/chat.delete"

querystring = {"channel":"channel","ts":"ts"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

ts
string
required

Timestamp of the most recently seen message.

Response

OK

channelstring
okboolean
tsstring
Suggest Edits

/chat.postMessage

 
Suggest Edits

get

Sends a message to a channel.

 
gethttps://slack.socialos.io/api/chat.postMessage
curl --request GET \
  --url 'https://slack.socialos.io/api/chat.postMessage?channel=channel&text=text'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/chat.postMessage',
  qs: 
   { channel: 'channel',
     text: 'text' } };

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

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

url = URI("https://slack.socialos.io/api/chat.postMessage?channel=channel&text=text")

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://slack.socialos.io/api/chat.postMessage?channel=channel&text=text");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/chat.postMessage"

querystring = {"channel":"channel","text":"text"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

text
string
required

Text of the message to send. See below for an explanation of formatting.

username
string

Name of bot.

parse
string

Change how messages are treated. See below.

link_names
string

Find and link channel names and usernames.

unfurl_links
string

Pass 1 to enable unfurling of primarily text-based content.

icon_url
string

URL to an image to use as the icon for this message

icon_emoji
string

emoji to use as the icon for this message. Overrides icon_url.

attachments
string

Structured message attachments.

Response

OK

channelstring
okboolean
tsstring
Suggest Edits

/chat.update

 
Suggest Edits

get

Updates a message.

 
gethttps://slack.socialos.io/api/chat.update
curl --request GET \
  --url 'https://slack.socialos.io/api/chat.update?channel=channel&text=text&ts=ts'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/chat.update',
  qs: 
   { channel: 'channel',
     text: 'text',
     ts: 'ts' } };

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

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

url = URI("https://slack.socialos.io/api/chat.update?channel=channel&text=text&ts=ts")

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://slack.socialos.io/api/chat.update?channel=channel&text=text&ts=ts");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/chat.update"

querystring = {"channel":"channel","text":"text","ts":"ts"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

text
string
required

Text of the message to send. See below for an explanation of formatting.

ts
string
required

Timestamp of the most recently seen message.

Response

OK

channelstring
okboolean
textstring
tsstring
Suggest Edits

/emoji.list

 
Suggest Edits

get

Lists custom emoji for a team.

 
gethttps://slack.socialos.io/api/emoji.list
curl --request GET \
  --url https://slack.socialos.io/api/emoji.list
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/emoji.list' };

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

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

url = URI("https://slack.socialos.io/api/emoji.list")

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://slack.socialos.io/api/emoji.list");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/emoji.list"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

emojiobject
emoji.bowtiestring
emoji.shipitstring
emoji.squirrelstring
okboolean
Suggest Edits

/files.info

 
Suggest Edits

get

Gets information about a team file.

 
gethttps://slack.socialos.io/api/files.info
curl --request GET \
  --url 'https://slack.socialos.io/api/files.info?file=file'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/files.info',
  qs: { file: 'file' } };

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

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

url = URI("https://slack.socialos.io/api/files.info?file=file")

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://slack.socialos.io/api/files.info?file=file");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/files.info"

querystring = {"file":"file"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

file
string
required

File to fetch info for

count
number

Number of items to return per page.

page
number

Page number of results to return.

Response

OK

fileobject
okboolean
Suggest Edits

/files.list

 
Suggest Edits

get

Lists and filters team files.

 
gethttps://slack.socialos.io/api/files.list
curl --request GET \
  --url 'https://slack.socialos.io/api/files.list?file=file'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/files.list',
  qs: { file: 'file' } };

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

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

url = URI("https://slack.socialos.io/api/files.list?file=file")

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://slack.socialos.io/api/files.list?file=file");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/files.list"

querystring = {"file":"file"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

file
string
required

File to fetch info for

user
string

Filter files created by a single user.

ts_from
string

Filter files created after this timestamp (inclusive).

ts_to
string

Filter files created before this timestamp (inclusive).

types
string

You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.

Response

OK

filesarray
okboolean
pagingobject
paging.countnumber
paging.pagenumber
paging.pagesnumber
paging.totalnumber
Suggest Edits

/files.upload

 
Suggest Edits

get

Uploads or creates a file.

 
gethttps://slack.socialos.io/api/files.upload
curl --request GET \
  --url https://slack.socialos.io/api/files.upload
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/files.upload' };

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

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

url = URI("https://slack.socialos.io/api/files.upload")

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://slack.socialos.io/api/files.upload");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/files.upload"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

file
string

File contents via multipart/form-data.

content
string

File contents via a POST var.

filetype
string

Slack-internal file type identifier.

filename
string

Filename of file.

title
string

Title of file.

initial_comment
string

Initial comment to add to file.

channels
string

Comma separated list of channels to share the file into.

Response

OK

fileobject
okboolean
Suggest Edits

/groups.history

 
Suggest Edits

get

Fetches history of messages and events from a private group.

 
gethttps://slack.socialos.io/api/groups.history
curl --request GET \
  --url 'https://slack.socialos.io/api/groups.history?channel=channel'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/groups.history',
  qs: { channel: 'channel' } };

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

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

url = URI("https://slack.socialos.io/api/groups.history?channel=channel")

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://slack.socialos.io/api/groups.history?channel=channel");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/groups.history"

querystring = {"channel":"channel"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Group to fetch history for.

latest
string

Timestamp of the oldest recent seen message.

oldest
string

Timestamp of the latest previously seen message.

count
number

Number of messages to return, between 1 and 1000.

has_more
boolean
is_limited
boolean

Response

OK

has_moreboolean
lateststring
messagesarray
okboolean
Suggest Edits

/groups.list

 
Suggest Edits

get

Lists private groups that the calling user has access to.

 
gethttps://slack.socialos.io/api/groups.list
curl --request GET \
  --url https://slack.socialos.io/api/groups.list
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/groups.list' };

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

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

url = URI("https://slack.socialos.io/api/groups.list")

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://slack.socialos.io/api/groups.list");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/groups.list"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

exclude_archived
string

Don't return archived channels.

Response

OK

groupsarray
okboolean
Suggest Edits

/groups.mark

 
Suggest Edits

get

Sets the read cursor in a private group.

 
gethttps://slack.socialos.io/api/groups.mark
curl --request GET \
  --url 'https://slack.socialos.io/api/groups.mark?channel=channel&ts=ts'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/groups.mark',
  qs: 
   { channel: 'channel',
     ts: 'ts' } };

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

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

url = URI("https://slack.socialos.io/api/groups.mark?channel=channel&ts=ts")

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://slack.socialos.io/api/groups.mark?channel=channel&ts=ts");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/groups.mark"

querystring = {"channel":"channel","ts":"ts"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Group to fetch history for.

ts
string
required

Timestamp of the most recently seen message.

Response

OK

okboolean
Suggest Edits

/groups.setPurpose

 
Suggest Edits

get

Sets the purpose for a private group.

 
gethttps://slack.socialos.io/api/groups.setPurpose
curl --request GET \
  --url 'https://slack.socialos.io/api/groups.setPurpose?channel=channel&purpose=purpose'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/groups.setPurpose',
  qs: 
   { channel: 'channel',
     purpose: 'purpose' } };

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

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

url = URI("https://slack.socialos.io/api/groups.setPurpose?channel=channel&purpose=purpose")

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://slack.socialos.io/api/groups.setPurpose?channel=channel&purpose=purpose");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/groups.setPurpose"

querystring = {"channel":"channel","purpose":"purpose"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Group to fetch history for.

purpose
string
required

The new purpose

Response

OK

okboolean
purposestring
Suggest Edits

/groups.setTopic

 
Suggest Edits

get

Sets the topic for a private group.

 
gethttps://slack.socialos.io/api/groups.setTopic
curl --request GET \
  --url 'https://slack.socialos.io/api/groups.setTopic?channel=channel&topic=topic'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/groups.setTopic',
  qs: 
   { channel: 'channel',
     topic: 'topic' } };

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

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

url = URI("https://slack.socialos.io/api/groups.setTopic?channel=channel&topic=topic")

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://slack.socialos.io/api/groups.setTopic?channel=channel&topic=topic");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/groups.setTopic"

querystring = {"channel":"channel","topic":"topic"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

topic
string
required

The new topic

Response

OK

okboolean
topicstring
Suggest Edits

/im.history

 
Suggest Edits

get

Fetches history of messages and events from direct message channel.

 
gethttps://slack.socialos.io/api/im.history
curl --request GET \
  --url 'https://slack.socialos.io/api/im.history?channel=channel'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/im.history',
  qs: { channel: 'channel' } };

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

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

url = URI("https://slack.socialos.io/api/im.history?channel=channel")

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://slack.socialos.io/api/im.history?channel=channel");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/im.history"

querystring = {"channel":"channel"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Direct message channel to fetch history for.

latest
string

Timestamp of the oldest recent seen message.

oldest
string

Timestamp of the latest previously seen message.

count
number

Number of messages to return, between 1 and 1000.

has_more
boolean
is_limited
boolean

Response

OK

has_moreboolean
lateststring
messagesarray
okboolean
 
Suggest Edits

get

Lists direct message channels for the calling user.

 
gethttps://slack.socialos.io/api/im.list
curl --request GET \
  --url https://slack.socialos.io/api/im.list
var request = require("request");

var options = { method: 'GET', url: 'https://slack.socialos.io/api/im.list' };

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

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

url = URI("https://slack.socialos.io/api/im.list")

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://slack.socialos.io/api/im.list");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/im.list"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

imsarray
okboolean
 
Suggest Edits

get

Sets the read cursor in a direct message channel.

 
gethttps://slack.socialos.io/api/im.mark
curl --request GET \
  --url 'https://slack.socialos.io/api/im.mark?channel=channel&ts=ts'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/im.mark',
  qs: 
   { channel: 'channel',
     ts: 'ts' } };

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

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

url = URI("https://slack.socialos.io/api/im.mark?channel=channel&ts=ts")

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://slack.socialos.io/api/im.mark?channel=channel&ts=ts");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/im.mark"

querystring = {"channel":"channel","ts":"ts"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

channel
string
required

Channel to fetch history for.

ts
string
required

Timestamp of the most recently seen message.

Response

OK

okboolean
Suggest Edits

/search.all

 
Suggest Edits

get

Searches for messages and files matching a query.

 
gethttps://slack.socialos.io/api/search.all
curl --request GET \
  --url 'https://slack.socialos.io/api/search.all?query=query'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/search.all',
  qs: { query: 'query' } };

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

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

url = URI("https://slack.socialos.io/api/search.all?query=query")

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://slack.socialos.io/api/search.all?query=query");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/search.all"

querystring = {"query":"query"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

query
string
required

Search query. May contains booleans, etc.

sort
string

Return matches sorted by either score or timestamp.

sort_dir
string

Change sort direction to ascending (asc) or descending (desc).

highlight
string

Pass a value of 1 to enable query highlight markers .

count
number

Number of items to return per page.

page
number

Page number of results to return.

Response

OK

channelobject
channel.creatednumber
channel.creatorstring
channel.idstring
channel.is_archivedboolean
channel.is_channelboolean
channel.is_generalboolean
channel.is_memberboolean
channel.last_readstring
channel.latestobject
channel.latest.attachmentsarray
channel.latest.textstring
channel.latest.tsstring
channel.latest.typestring
channel.latest.userstring
channel.membersarray
channel.namestring
channel.purposeobject
channel.purpose.creatorstring
channel.purpose.last_setnumber
channel.purpose.valuestring
channel.topicobject
channel.topic.creatorstring
channel.topic.last_setnumber
channel.topic.valuestring
channel.unread_countnumber
channel.unread_count_displaynumber
okboolean
Suggest Edits

/search.files

 
Suggest Edits

get

Searches for files matching a query.

 
gethttps://slack.socialos.io/api/search.files
curl --request GET \
  --url 'https://slack.socialos.io/api/search.files?query=query'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/search.files',
  qs: { query: 'query' } };

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

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

url = URI("https://slack.socialos.io/api/search.files?query=query")

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://slack.socialos.io/api/search.files?query=query");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/search.files"

querystring = {"query":"query"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

query
string
required

Search query. May contains booleans, etc.

sort
string

Return matches sorted by either score or timestamp.

sort_dir
string

Change sort direction to ascending (asc) or descending (desc).

highlight
string

Pass a value of 1 to enable query highlight markers .

count
number

Number of items to return per page.

page
number

Page number of results to return.

Response

OK

filesobject
files.matchesarray
files.paginationobject
files.pagination.firstnumber
files.pagination.lastnumber
files.pagination.pagenumber
files.pagination.page_countnumber
files.pagination.per_pagenumber
files.pagination.total_countnumber
files.pagingobject
files.paging.countnumber
files.paging.pagenumber
files.paging.pagesnumber
files.paging.totalnumber
files.totalnumber
okboolean
querystring
Suggest Edits

/search.messages

 
Suggest Edits

get

Searches for messages matching a query.

 
gethttps://slack.socialos.io/api/search.messages
curl --request GET \
  --url 'https://slack.socialos.io/api/search.messages?query=query'
var request = require("request");

var options = { method: 'GET',
  url: 'https://slack.socialos.io/api/search.messages',
  qs: { query: 'query' } };

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

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

url = URI("https://slack.socialos.io/api/search.messages?query=query")

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://slack.socialos.io/api/search.messages?query=query");

xhr.send(data);
import requests

url = "https://slack.socialos.io/api/search.messages"

querystring = {"query":"query"}

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

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

query
string
required

Search query. May contains booleans, etc.

sort
string

Return matches sorted by either score or timestamp.

sort_dir
string

Change sort direction to ascending (asc) or descending (desc).

highlight
string

Pass a value of 1 to enable query highlight markers .

count
number

Number of items to return per page.

page
number

Page number of results to return.

Response

OK

messagesobject
messages.matchesarray
messages.paginationobject
messages.pagination.firstnumber
messages.pagination.lastnumber
messages.pagination.pagenumber
messages.pagination.page_countnumber
messages.pagination.per_pagenumber
messages.pagination.total_countnumber
messages.pagingobject
messages.paging.countnumber
messages.paging.pagenumber
messages.paging.pages