Skip to content

Main Navigation Guide Rest API Wiki

Appearance

Sidebar Navigation

API Reference

achievement

GET Get all achievements that belong to a region

POST Add a new achievement

DELETE Delete an existing achievement

PATCH Edit an existing achievement

GET Get details about all users that have a specific achievement

POST Award an achievement to a user

DELETE Revoke an achievement from a user

PATCH Edit an awarded achievement of a user

activities

GET Returns the filters for all dashboard activities for the current user

PATCH Sets which dashboard activities should be deactivated for the current user.

GET Returns the updates to display on the dashboard

application

DELETE Declines an application for a work group

PATCH Accepts an application for a work group

GET Returns all pending applications for a working group

groups

POST Requests to join a group.

POST Adds a member to a working group.

PATCH PATCH /api/groups/{groupId}

POST Sends a message to a group via email, including a custom message from the contact form.

GET Returns the list of working groups in a group or region.

banana

POST Gives a banana to a user

DELETE DELETE /api/users/{recipientId}/bananas/{senderId}

GET Returns basic metadata about the bananas of a user

GET Returns the bananas given to a user

GET Returns the bananas given by a user

basket

GET Returns all current baskets of the user

GET Returns a list of baskets close to a given location.

GET Returns details of a basket

DELETE Removes a new basket

PATCH Updates an existing basket

POST Adds a new basket

POST Requests a basket

DELETE Withdraws a basket requests

PATCH Updates the status of a basket request

bells

GET Returns all bells for the current user

DELETE Deletes bells for the current user

PATCH Sets the read status of one or more bells as unread/read

blog

GET Returns blog posts.

POST Adds a new blog post

GET Returns a specific blog post.

DELETE Removes a blogpost.

PATCH Edit a specific blog post.

PUT Sets a specific blog posts published status.

buddy

POST Sends a buddy request to a user.

DELETE Removes a buddy request to a user.

GET Returns a list of all buddies with id, name, and photo.

calendar

GET Returns the user's current access token

PUT Creates a new random access token for the user, replacing the old one

DELETE Removes the user's access token

GET Returns the user's foodsharing calendar as iCal

categories

GET Returns all existing categories of the given type

POST Adds a category

DELETE Deletes a category

PATCH Changes a category

POST Merge two categories

content

GET Returns a list of all content entries.

POST Adds a new content entry

GET Returns the content entries for one of more comma-separated ids.

DELETE DELETE /api/contents/{contentId}

PATCH Updates the content entry with the specific id.

donation

GET Returns cached information of foodsharing donation-goal via third service provider twingle.

PATCH Updates cached information of foodsharing donation-goal via third service provider twingle.

GET Returns information about donation-projects via third service provider twingle.

admin

GET List all email blocklist entries

POST Create a new email blocklist entry

GET Get a single email blocklist entry

DELETE Delete an email blocklist entry

PATCH Update an existing email blocklist entry

verification

PUT Sends a new verification email to a specified address if an account with that address exists and is not yet verified

GET Returns a users (de-)verification history

POST Changes verification status of one user to verified

DELETE Changes verification status of one user to deverified

GET Returns whether a user's identity is confirmed, together with the data to check

POST Confirms a user's identity

DELETE Reverts the confirmation of a user's identity

GET Returns a users pass history

GET Returns the current users foodsaver passport

POST Create foodsaver passports for given users in region

GET Returns the wallet URL for the current user

events

PUT Updates the user's response to an invitation.

GET List events for region and groups.

POST Add a new event.

PATCH Edit an event.

feature-toggle

GET Returns all feature toggles

GET Checks if a feature toggle is active or not

PATCH Changes a feature toggle state

foodSharePoints

GET Returns details of the food share point with the given ID.

DELETE Delete an existing food share point.

PATCH Edit an existing food share point.

GET Returns a list of all food share points in a region and all its subregions.

POST Adds or suggests a new food share point.

GET Returns the permissions the logged in user has for the given food share point

POST Follow a food share point

DELETE Unfollow a food share point

PATCH Accept a suggested food share point

foodsaver

GET Lists a users agenda on a specific day, including pickups and events

forum

GET Get forum following status.

PUT Set forum following status.

GET List threads of a forum

POST Create a thread inside a forum.

GET Returns a forum thread including all posts

DELETE Deletes a non-activated forum thread

PATCH Change attributes for a thread: Stickiness, activate thread, status.

POST Request email notifications for activities in at thread.

DELETE Removes email notifications for activities in a thread.

POST Request bell notifications for activities in a thread.

DELETE Removes bell notifications for activities in a thread.

POST Creates a post inside a thread.

DELETE Deletes a forum post.

PATCH Edit a forum post (author only, within allowed time)

DELETE Restore a hidden forum post

PATCH Hide a forum post.

POST Adds an emoji reaction to a post. An emoji is an arbitrary string but needs to be supported by the frontend.

DELETE Remove an emoji reaction the logged in user has given from a post.

region

GET Returns the properties of a specific region.

DELETE Delete a region or a working group.

PATCH Edits the region using the given data.

GET Returns the join URL of a given groups conference.

PUT Join a region.

DELETE Removes the current user from a region.

GET Returns the region options for a specific region.

PATCH Sets the options for region.

GET Returns the user's permissions for setting the region options.

GET Returns the public region data.

PATCH Sets the public data for a region.

GET Returns a list of all subregions including working groups of a region.

GET Returns a list of all members for a region.

DELETE Removes a member from a region or working group.

PUT Sets an user as Admin / Ambassador of a region / workgroup.

DELETE Removes a user as Admin / Ambassador of a region / workgroup.

GET Returns the permissions that this user has concerning administration of the members in the region.

POST Adds a region using the given data.

GET Returns the region menu data.

GET Returns all ancestors of a region until the first accessible one (region or group with membership)

GET Suggests regions that are likely responsible for a location, best match first.

locale

GET Returns the locale setting for the current session.

PUT Sets the locale for the current session.

GET Returns all available languages

mailbox

GET Return a mail from mailbox.

DELETE Moves an email to the trash folder or deletes it, if it is already in the trash.

PATCH Changes properties of an email.

GET Returns the number of unread mails for the sending user.

GET Returns the mailboxes of the current user, including their unread mail counts.

GET Returns mails from a mailbox.

POST Sends an email from a mailbox.

GET Returns all regions and their email addresses.

map

GET Returns all basket markers.

GET Returns all food share point markers.

GET Returns all region markers.

GET Returns all store markers.

GET Returns all user markers.

GET Returns of all event markers.

GET Returns details on a region marker

GET Returns details on a food share point marker

GET Returns details on a basket marker

GET Returns details on a store marker

GET Returns details on a event marker

GET Returns details on a user marker

conversation

PUT Mark conversation as read/unread

GET Get messages from a conversation

POST Send a message in a conversation

GET Get a conversation including some messages

PATCH Rename a conversation

POST Returns the conversation ID for a conversation between the current user and given others. The conversion is created if it does not exist yet.

GET Get the list of conversations for the current user

notifications

GET Get the general notification settings

PATCH Update the general notification settings

GET Get the threads notification settings

PATCH Update the threads notification settings

GET Get the food share points notification settings

PATCH Update the food share points notification settings

GET Get the region notification settings

PATCH Update the regions notification settings

GET Get the newsletter notification settings

PATCH Update the newsletter notification settings

Default

GET GET /api/admin/oauthclients

POST POST /api/admin/oauthclients

GET GET /api/admin/oauthclients/{identifier}

DELETE DELETE /api/admin/oauthclients/{identifier}

PATCH PATCH /api/admin/oauthclients/{identifier}

GET Simple debug API returning server time and HTTPS flag.

passkey

POST Generate registration options for creating a new passkey

POST Verify and save a new passkey credential

POST Generate authentication options for passkey login

POST Verify passkey authentication and log in the user

GET List all passkeys for the current user

DELETE Delete a passkey

PATCH Rename a passkey

petition

GET Returns possibly cached information of foodsharing petition at bundestag.

pickup

POST Join a pickup slot

DELETE Remove a user from a pickup

PATCH Confirm a pickup slot

DELETE Remove a user from all his pickups

GET Get the regular pickups for a store

PUT Set the regular pickups for a store

PUT Create or modify a manual pick up for a store

GET List pickups for a store

GET List pickup history for a store

GET Get past pickups for a user

GET Get future registered pickups for a user

GET Get all pickup options a user has, including already registered slots

GET Check if a user may enter a specific pickup based on pickup rules

push-notification

GET Returns information necessary for registering subscribing to push notifications with this handler

POST Subscribes to push notifications with the specified handler

DELETE Unsubscribes from push notifications with the specified handler

quiz

POST Starts a new quiz session

GET Returns the status of the users current quiz progress

GET Returns the next question of the quiz for the currently answering user.

POST Answer the current quiz question

GET Returns the results of the last time the current user finished the quiz

POST Confirm the finalization of a passed quiz

GET Returns a users quiz sessions

DELETE Deletes a quiz session

GET Returns the details of a quiz

PATCH Changes the properties of a quiz

GET Returns all questions of a quiz including answers

POST Adds a new question to a quiz

DELETE Removes a quiz question

PATCH Updates a quiz question

POST Adds a new answer to a question

DELETE Removes an answer

PATCH Updates an answer

report

GET List reports for a region

GET List reports for a user

POST Add a new report

DELETE Delete a report

PATCH Update a report status, consequence, or forum thread link

resource

GET Get the list of resource categories.

GET Get the list of resources available in a given region.

GET Get the list of resources of the logged in user

POST Add a new resource for the logged in user.

POST Add a new commons resource for the given region.

DELETE Delete a resource.

PATCH Edit a resource.

POST Favorite a resource.

DELETE Unfavorite a resource.

GET Get the current users permissions related to resources in a given region.

search

GET Search for users

GET General search endpoint

GET Search index for quick local search of likely searched entities

GET Search threads in a specific forum

server

GET Returns server configuration data and user context for the frontend. This includes user data, permissions, environment settings, and API keys.

GET Returns all registered routes in the application.

settings

PATCH Sets the current users sleep mode.

PATCH Requests that the users login email address will be changed.

PATCH Changes the user's password.

POST Request 2FA secret, backup codes and QR code.

PATCH Edit 2FA settings.

GET Get the user profile information.

statistics

GET Returns the gender distribution from a region

GET Returns the age band distribution from a region

GET Returns the pickup statistics of a region

GET Returns general foosharing statistics

chain

GET Returns the list of store chains

POST Creates a new store

GET Returns a specific store chain

PATCH Updates a store chain

GET Returns the list of stores that are part of a given chain

stores

GET Get general store metadata

GET Get the stores where a user is member of

GET Get the stores of a region

POST Create a new store

GET Get detailed information about a store

PATCH Edit store details

GET Get the members of a store team

GET Get the permissions of the logged in user for a store

GET Get the requests to a store team

POST Request to join a store team

DELETE Decline a request to join a store team

PATCH Accept a request to join a store team

GET Get the invitations to a store team

POST Invite a user to a store team

DELETE Withdraw an invitation to a store team

DELETE DELETE /api/stores/{storeId}/invitations/current

PATCH Accept an invitation to a store team

DELETE Remove a user from a store team

POST Make a user a store manager

DELETE Demote a user from store manager to regular store team member

DELETE Move a store team member to the regular team

PATCH Move a store team member to the standby team

GET Get store log entries for the given time range and action types

DELETE Delete a store

support

POST Creates a new support ticket

test

DELETE Clear a specific cache key.

upload

GET Returns the image with the requested UUID. Width and height must both be given or can be set both to 0 to indicate no resizing.

GET GET /api/uploads/{uuid}/metadata

POST POST /api/uploads

user

GET Lists basic information for a user

DELETE Deletes a user account

GET Lists detailed information for the current user

POST Logs in a user with email and password

POST Logs out the current user

POST Initialises the registration of a new user.

POST Registers a new user

PUT Sets a previously uploaded picture as the user's profile photo

DELETE Removes the user from the email bounce list

GET Gets the names of multiple users by their IDs

PATCH Updates the user profile information.

POST Request a password reset by email

POST Reset password using a reset token.

GET Validate a password reset token.

polls

GET Returns the details of a poll.

DELETE Deletes a poll.

PATCH Updates an existing poll.

GET Lists all polls in a region or working group.

GET Lists all polls the user is invited to.

POST Vote in a poll.

POST Creates a new poll.

wall

GET Get posts of a wall.

POST Add a post to a wall.

DELETE Delete a post from a wall.

POST Adds a reactions to a post.

DELETE Removes one of your a reactions from a post.

Removes a new basket

DELETE

/api/baskets/{basketId}

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

Type

API Key (header: X-CSRF-Token)

Parameters

Path Parameters

basketId*

Type

integer

Required

Minimum

1

Responses

Success

DELETE

/api/baskets/{basketId}

Playground

Authorization

api_key

Variables

Key

Value

basketId*

Samples

Pager

Previous page GET Returns details of a basket

Next page PATCH Updates an existing basket