Curl Python

API Documentation

Upscale is changing the way people work.

 

Authentication

Api Endpoints for user and organization authentication

  1. Login
  2. Logout
  3. Register
  4. Activate
  5. Subscribe
 

Login

Login to your Upscale account.

Parameters

Key Value(s) Desc Required
email unicode X
password unicode at least X characters X
GET
/login
https://getupscale.com/api/v1/auth/login

Example Request

Example Response

 
 

List users

List users

Parameters

Key Value(s) Desc Required
GET
/resource/
resource-id

Example Request

Example Response

 

Organizations

Organizations API endpoints.

  1. List Organizations
  2. Create an Organization
  3. Invite a User (planned)
 

List Organizations

Returns a paginated list of organization ids

Parameters

Key Value(s) Desc Required
GET
/accept/
transaction-id
/resource/
https://api.getupscale.com/v1/accept/92351948724923469873/resource/

Example Request

Example Response

 
 

List Your Teams

Shows teams matching one of the following three criteria based on the show=x parameter.

Parameters

Key Value(s) Desc Required
show [accepting (default) | requested | assigned | org missions]
limit int
page int
GET
/resource/
resource-id

Example Request

Response

 

Session

Interact with information related to an individual's active browser session

  1. Status
  2. Assignments
 

Session Status

Returns information about the browser session of the currently logged in user.

Parameters

Key Value(s) Desc Required
GET
/status
https://getupscale.com/api/v1/session/status

Example Request

Response

{ status: "success", response: { activated: true, full_name: "Michael E. Karpeles", submitted: false, type: "Supervisor", api_token: "XXX", username: "mek", logged: true, clearance: 15, id: 1, email: "m@hackerlist.net", avatar: "https://s.gravatar.com/avatar/7ca82283af0b65b163dde4f5f5e3fb41?s=250", orgs: [] } }
 

Roles

The different Role Value(s)s on Upscale

https://getupscale.com/api/v1/roles
 

List Roles

Parameters

Key Value(s) Desc Required
GET
/resource/
resource-id

Example Request

Response

 

Tags

The different Tags on Upscale, which are basically StackOverflows.

https://getupscale.com/api/v1/tags
 

List Tags

Parameters

Key Value(s) Desc Required
GET
/resource/
resource-id

Example Request

Example Response

 

Errors

Standard HTTP status codes are used to communicate the success or failure of a request. A code in the 2xx range indicates success, 4xx indicates an error that resulted from the provided information (e.g. a required parameter was missing, a bank account failed tokenization, etc), 5xx indicates an error with Upscale's servers.

HTTP Status Codes

200 ok: resource(s) retrieved successfully.
201 created: resource created.
204 no content: resource deleted.
400 bad request: request is improper and/or malformed.
401 unauthorized: http authentication must be used to access the requested uri.
403 forbidden: not authorized to access the resource at the requested uri.
404 not found: requested uri doesn't exist.
405 method not allowed: http method used is not allowed for the requested uri.
409 conflict: the request was correctly formed but had a logical error.
500, 502, 503, 504 internal server error: something went wrong on Upscale's side.