Scan Harvest API

Profile

Endpoint:http://localhost:8000/api/v1

Get user by ID

GET

http://localhost:8000/api/v1

/profiles/{id}

Get user details by their ID

Get user by ID › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Get user by ID › Responses

User found

avatar_idstring
created_atstring
emailstring
first_namestring
last_namestring
user_idstring
worker_codestring

Delete user

DELETE

http://localhost:8000/api/v1

/profiles/{id}

Soft delete or permanently delete a user by their ID

Delete user › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Delete user › query Parameters

permanentboolean
Whether to permanently delete the user

Delete user › Responses

User deleted successfully

data
errorsobject
infoobject
request_idstring

Update user

PATCH

http://localhost:8000/api/v1

/profiles/{id}

Update user details by their ID

Update user › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Update user › Request Body

avatarstring
first_namestring
last_namestring

Update user › Responses

User updated successfully

data
errorsobject
infoobject
request_idstring

Change user password

PUT

http://localhost:8000/api/v1

/profiles/{id}/password

Allows a logged-in user to change their password

Change user password › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Change user password › Request Body

emailstring
passwordstring

Change user password › Responses

Password updated successfully

data
errorsobject
infoobject
request_idstring

Get user QR code

GET

http://localhost:8000/api/v1

/profiles/{id}/qrcode

Generate and retrieve a QR code for a user by their ID

Get user QR code › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Get user QR code › Responses

QR code generated successfully

qrstring

Sessions subscriptions

Scan Harvest API

Profile

Endpoint:http://localhost:8000/api/v1

Get user by ID

GET

http://localhost:8000/api/v1

/profiles/{id}

Get user details by their ID

Get user by ID › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Get user by ID › Responses

User found

avatar_idstring
created_atstring
emailstring
first_namestring
last_namestring
user_idstring
worker_codestring

Delete user

DELETE

http://localhost:8000/api/v1

/profiles/{id}

Soft delete or permanently delete a user by their ID

Delete user › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Delete user › query Parameters

permanentboolean
Whether to permanently delete the user

Delete user › Responses

User deleted successfully

data
errorsobject
infoobject
request_idstring

Update user

PATCH

http://localhost:8000/api/v1

/profiles/{id}

Update user details by their ID

Update user › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Update user › Request Body

avatarstring
first_namestring
last_namestring

Update user › Responses

User updated successfully

data
errorsobject
infoobject
request_idstring

Change user password

PUT

http://localhost:8000/api/v1

/profiles/{id}/password

Allows a logged-in user to change their password

Change user password › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Change user password › Request Body

emailstring
passwordstring

Change user password › Responses

Password updated successfully

data
errorsobject
infoobject
request_idstring

Get user QR code

GET

http://localhost:8000/api/v1

/profiles/{id}/qrcode

Generate and retrieve a QR code for a user by their ID

Get user QR code › path Parameters

idstring · required
User ID (UUID) or 'me' for the authenticated user

Get user QR code › Responses

QR code generated successfully

qrstring

Sessions subscriptions