Auth

get

Retrieve the user's own profile.

Responses

200

Default Response

application/json

_idstringRequired

emailstringRequired

first_namestringRequired

last_namestringRequired

photo_urlstringRequired

last_sitestringOptional

get/users/@me

GET /users/@me HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "photo_url": "text",
  "last_site": "text"
}

post

Generate a presigned URL for a user avatar

Body

content_typestringRequired

Responses

200

Default Response

application/json

urlstringRequired

object_idstringRequired

post/users/avatar

POST /users/avatar HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "content_type": "text"
}

200

Default Response

{
  "url": "text",
  "object_id": "text"
}

put

Upload a user avatar

Body

object_idstringRequired

Responses

200

Default Response

application/json

raw_urlstringRequired

source_uristringRequired

uploadedbooleanRequired

object_idstringRequired

put/users/avatar

PUT /users/avatar HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "object_id": "text"
}

200

Default Response

{
  "raw_url": "text",
  "source_uri": "text",
  "uploaded": true,
  "object_id": "text"
}

patch

Set the last site hint for a user.

Body

site_idstringRequired

Responses

200

Default Response

application/json

successbooleanRequired

patch/users/@me/hint

PATCH /users/@me/hint HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "site_id": "text"
}

200

Default Response

{
  "success": true
}

post

Request a password reset email.

Body

emailstringRequired

Responses

200

Default Response

application/json

successbooleanRequired

post/users/password-reset/request

POST /users/password-reset/request HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "email": "text"
}

200

Default Response

{
  "success": true
}

post

Reset password using a reset token.

Body

tokenstringRequired

passwordstringRequired

Responses

200

Default Response

application/json

successbooleanRequired

400

Default Response

application/json

post/users/password-reset/reset

POST /users/password-reset/reset HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "token": "text",
  "password": "text"
}

{
  "success": true
}

post

Login a user.

Body

emailstringRequired

passwordstringRequired

new_passwordstringOptional

Responses

200

Default Response

application/json

successbooleanRequired

401

Default Response

application/json

409

Default Response

application/json

post/users/sessions/

POST /users/sessions/ HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "email": "text",
  "password": "text",
  "new_password": "text"
}

{
  "success": true
}

delete

Logout a user.

Responses

200

Default Response

application/json

successbooleanRequired

delete/users/sessions/

DELETE /users/sessions/ HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "success": true
}

post

Refresh the access token.

Responses

200

Default Response

application/json

accessbooleanRequired

post/users/sessions/refresh

POST /users/sessions/refresh HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "access": true
}