Accounts

GET /accounts

Reponses

  1. A list of all registered accounts. Not paginated. The request will return with status code 200.

GET /accounts/{id}

The id param must be a valid Account ID.

Reponses

  1. The matching account. Status code 200.
  2. An error saying the account was not found. Status code 404.

POST /accounts

Request

A valid Account JSON object in the request body.

Responses

  1. The newly created account. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422

PUT /accounts/{id}

Request

The id param must be a valid Account ID.

A valid Account JSON object in the request body. The password field may be omitted.

Responses

  1. The updated account. Status code 200.
  2. A list of validation errors. Status code 422.
  3. An error saying the account was not found. Status code 404.

DELETE /accounts/{id}

The id param must be a valid Account ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the account was not found. Status code 404.

Captions

GET /captions

Reponses

  1. A paginated list of captions. The request will return with status code 200.

GET /captions/{id}

The id param must be a valid Caption ID.

Reponses

  1. The matching caption. Status code 200.
  2. An error saying the caption was not found. Status code 404.

POST /captions

Request

A valid Caption JSON object in the request body.

Responses

  1. The newly created caption. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422

PUT /captions/{id}

Request

The id param must be a valid Caption ID.

A valid Caption JSON object in the request body.

Responses

  1. The updated caption. Status code 200.
  2. A list of validation errors. Status code 422.
  3. An error saying the caption was not found. Status code 404.

DELETE /captions/{id}

The id param must be a valid Caption ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the caption was not found. Status code 404.

Logs

GET /logs

Request

  • accounts: a list of account IDs to show. If omitted, all accounts will be included
  • levels: a list of log levels to show. If omitted, all levels will be included

Reponses

  1. A paginated list of logs. The request will return with status code 200.

GET /logs/{id}

The id param must be a valid Log ID.

Reponses

  1. The matching log. Status code 200.
  2. An error saying the log was not found. Status code 404.

POST /logs

Request

A valid Log JSON object in the request body, except for the date. The user key is also optional.

Responses

  1. The newly created log. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422.

DELETE /logs/{id}

The id param must be a valid Log ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the log was not found. Status code 404.

Posts

GET /posts

Request

  • after: A date formatted string. Posts before the date will not be included.
  • platforms: A list of platforms to get the posts from. If omitted, all platforms will be included.

Reponses

  1. A paginated list of posts. The request will return with status code 200.

GET /posts/{id}

The id param must be a valid Post ID.

Reponses

  1. The matching post. Status code 200.
  2. An error saying the post was not found. Status code 404.

GET /posts/{platform}/{originalId}

The platform param must be the platform where the post is from (twitter, instagram, ...). The originalId is the ID it had in that platform.

Reponses

  1. The matching post. Status code 200.
  2. An error saying the post was not found. Status code 404.

POST /posts

Request

A valid Post JSON object in the request body.

Responses

  1. The newly created post. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422

PUT /posts/{id}

Request

The id param must be a valid Post ID.

A valid Post JSON object in the request body.

Responses

  1. The updated post. Status code 200.
  2. A list of validation errors. Status code 422.
  3. An error saying the post was not found. Status code 404.

DELETE /posts/{id}

The id param must be a valid Post ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the post was not found. Status code 404.

Schedule

GET /schedule

Request

  • account: An account ID. Only that account's scheduled posts will be shown. If omitted, all schedules will be returned.
  • onlyScheduled: Boolean, if true it will not return scheduled posts past the current date.
  • after: A date. If set, it will not return scheduled posts past the given date.

Reponses

  1. A list of schedules. Not paginated. The request will return with status code 200.

GET /schedule/{id}

The id param must be a valid Schedule ID.

Reponses

  1. The matching schedule. Status code 200.
  2. An error saying the schedule was not found. Status code 404.

POST /schedule

Request

A valid Schedule JSON object in the request body.

Responses

  1. The newly created schedule. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422

PUT /schedule/{id}

Request

The id param must be a valid Schedule ID.

A valid Schedule JSON object in the request body.

Responses

  1. The updated schedule. Status code 200.
  2. A list of validation errors. Status code 422.
  3. An error saying the schedule was not found. Status code 404.

DELETE /schedule/{id}

The id param must be a valid Schedule ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the schedule was not found. Status code 404.

Sources

GET /sources

Reponses

  1. A list of sources. Not paginated. The request will return with status code 200.

GET /sources/{id}

The id param must be a valid Source ID.

Reponses

  1. The matching source. Status code 200.
  2. An error saying the source was not found. Status code 404.

POST /sources

Request

A valid Source JSON object in the request body.

Responses

  1. The newly created source. The request will return with status code 201 and the Location header pointing to the newly created resource.
  2. A list of validation errors. The request will return with status code 422

PUT /sources/{id}

Request

The id param must be a valid Source ID.

A valid Source JSON object in the request body.

Responses

  1. The updated source. Status code 200.
  2. A list of validation errors. Status code 422.
  3. An error saying the source was not found. Status code 404.

DELETE /sources/{id}

The id param must be a valid Source ID.

Reponses

  1. Empty body, the deletion was successful. Status code 200.
  2. An error saying the source was not found. Status code 404.