QuickSnipp API Server - v1.0
View Quicksnipp's various REST endpoints along with usage for different requests. Quicksnipp is built with Python, Django + DRF for the API server. Front-end uses Node.js, Express, and React

/auth

Request an authentication token to be used along with other requests.

Required Parameters
  • (Body) - username: [String]
  • (Body) - password: [String]

/groups

Get all groups available to the currently authenticated user.

Required Parameters
  • (Header) - Authorization Token

Create a new group for the authenticated user

Required Parameters
  • (Header) - Authorization Token
  • (Body) - user_id: [Integer]
  • (Body) - collection_id: [Integer]
  • (Body) - name: [String]
  • (Body) - description: [String]
  • (Body) - type: [String]

/group/{id}

Get a specific group by ID. Must be a snippet owned by the authenticated user.

  • (Header) - Authorization Token

Update a specific group's details. Must be a group owned by the authenticated user.

Optional Parameters
  • (Header) - Authorization Token
  • (Body) - title: [String]
  • (Body) - description: [String]
  • (Body) - label_color: [String or HEX color code]

Delete a specific group. Must be a group owned by the authenticated user.

Note: Deleteing a code group will preserve snippets and their related files!

Required Parameters
  • (Header) - Authorization Token

/snippets

Get all snippets available to the currently authenticated user.

Required Parameters
  • (Header) - Authorization Token

Create a new snippet for the authenticated user

Required Parameters
  • (Header) - Authorization Token
  • (Body) - user_id: [Integer]
  • (Body) - group_id: [Integer]
  • (Body) - title: [String]
  • (Body) - description: [String]

/snippet/{id}

Get a specific snippet by ID. Must be a snippet owned by the authenticated user.

  • (Header) - Authorization Token

Update a specific snippet's details. Must be a snippet owned by the authenticated user.

Optional Parameters
  • (Header) - Authorization Token
  • (Body) - title: [String]
  • (Body) - description: [String]
  • (Body) - group_id: [Integer]

Delete a specific snippet. Must be a snippet owned by the authenticated user.

Note: Deleteing a code snippet will remove their related files!

Required Parameters
  • (Header) - Authorization Token

/files

Get all files available to the currently authenticated user.

Required Parameters
  • (Header) - Authorization Token

Create a new file for the authenticated user

Required Parameters
  • (Header) - Authorization Token
  • (Body) - title: [String]
  • (Body) - description: [String]
  • (Body) - snippet_id: [Integer]
  • (Body) - language: [String]
  • (Body) - code: [String]

/file/{id}

Get a specific file by ID. Must be a file owned by the authenticated user.

  • (Header) - Authorization Token

Update a specific file's details. Must be a file owned by the authenticated user.

Optional Parameters
  • (Header) - Authorization Token
  • (Body) - title: [String]
  • (Body) - description: [String]
  • (Body) - snippet_id: [Integer]
  • (Body) - language: [String]
  • (Body) - code: [String]

Delete a specific file. Must be a file owned by the authenticated user.

Required Parameters
  • (Header) - Authorization Token

/users

Create a new user. Does not require authentication.

Required Parameters
  • (Body) - username: [String]
  • (Body) - email: [String]
  • (Body) - password: [Integer]

/user/{id}

Get a specific user and details by ID. Must be a user that is currently authenticated.

  • (Header) - Authorization Token

Update a specific user's details. Must be a user that is currently authenticated.

Optional Parameters
  • (Header) - Authorization Token
  • (Body) - username: [String]
  • (Body) - email: [String]

Delete a specific user. Must be a user that is currently authenticated.

Note: Deleteing a user will remove all their related groups, snippets, and files!

Required Parameters
  • (Header) - Authorization Token