DRF Docs

Document Web APIs made with Django REST Framework.

accounts

/accounts/login/

POST
OPTIONS

A view that allows users to login providing their username and password.

Fields:

username: CharField R
password: CharField R

/accounts/register/

POST
OPTIONS

Fields:

username: CharField R
email: EmailField R
full_name: CharField R
password: CharField R

/accounts/reset-password/

POST
OPTIONS

No fields.

/accounts/user/profile/

GET
PUT
PATCH
OPTIONS

An endpoint for users to view and update their profile information.

Fields:

username: CharField R
email: EmailField R
full_name: CharField R
password: CharField R
is_active: BooleanField

organisations

/organisations/create/

POST
OPTIONS

Allows users create an organisation.

Fields:

name: CharField R
slug: SlugField R

/organisations/<slug>/members/

GET
OPTIONS

List all the members for an organisation. User should be a member of that organisation.

Fields:

joined: DateTimeField
user: SerializerMethodField
is_owner: BooleanField

/organisations/<slug>/leave/

DELETE
OPTIONS

Users can leave an organisation if they are not the owner or the only admin.

No fields.