Skip to content

slickplan/api-docs

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Slickplan API

This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.

We provide Slickplan OAuth 2.0 support for the PHP League's OAuth 2.0 Client. Please see our slickplan/oauth2-slickplan-php package.

Making Requests

The Base URL

All requests start with the https://slickplan.com/api/v1/ base URL.

  • All requests are done via SSL only.
  • All responses are in JSON.
  • The API expects all data to be UTF-8 encoded.

Authentication

In order to make authorized calls to Slickplan's API, your application must first obtain an OAuth access token. To register your app go to https://slickplan.com/api/register (to modify your existing application details go to https://slickplan.com/api/register/<client_secret>).

Slickplan implements OAuth2 with the authentication code flow. Read our OAuth2 authentication guide to get started.

Once you have authenticated, you can get information about the authenticated user by calling GET https://slickplan.com/api/v1/me. More details about the request and response are available on the endpoint page.

Rate Limiting

You can perform up to 25 requests per 10 second period on an account with one OAuth token. If you exceed this limit, you'll get a 403 Rate Limit Exceeded response for subsequent requests. Check the Retry-After header to see how many seconds to wait before retrying the request.

Response Codes

  • 200 OK
  • 201 Created
  • 204 No content
  • 400 Bad Request / Validation errors
  • 401 Unauthorized
  • 403 Access denied / Insufficient scope
  • 404 Not found
  • 5xx Slickplan is having trouble 🤒

Endpoints

Account & Settings

Projects

Informations

Support

Having trouble with this API? Contact us directly via email help@slickplan.com.

About

Slickplan v1 API Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published