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 object for ActivityOverview 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.

banana

PUT Gives a banana to a user

DELETE DELETE /api/user/{recipientId}/banana/{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. If the location is not valid the user's home location is used. The distance is measured in kilometers.

GET Returns details of the basket with the given ID. Returns 200 and the basket, 500 if the basket does not exist, or 401 if not logged in.

PUT Updates the description of an existing basket. The description must not be empty. If the location is not given or invalid it falls back to the user's home. Returns the updated basket.

DELETE Removes a basket of this user with the given ID. Returns 200 if a basket of the user was found and deleted, 404 if no such basket was found, or 401 if not logged in.

POST Adds a new basket. The description must not be empty. All other parameters are optional. Returns the created basket.

POST Requests a basket.

POST Withdraw a basket request.

PATCH Updates the status of a basket request. The creator of a basket can set the status of requests for their basket (e.g. mark as picked up, not picked up, denied etc.).

bells

GET Returns all bells for the current user.

DELETE Deletes a bell.

PATCH Makes sure that one or more bells are marked as unread/read. Bells that were already marked with that status will not be altered.

blog

GET Returns a page from the list of blog posts. The page can be empty if the page number is too large.

POST Publishes a new blog post. The post will be publicly visible immediately.

GET Returns a specific blog post.

DELETE Removes one blogpost from the database.

PATCH PATCH /api/blog/{blogId}

PATCH PATCH /api/blog/{blogId}/publish

buddy

PUT PUT /api/buddy/{userId}

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. An existing token will be overwritten. Returns the created token.

DELETE Removes the user's token. If the user does not have a token nothing will happen.

GET Returns the user's future foodsharing dates as iCal.

categories

GET Returns all existing categories

POST Adds a category

DELETE DELETE /api/categories/{type}/{id}

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 entry for a specific id.

DELETE Deletes the content entry with the specific id.

PATCH PATCH /api/content/{contentId}

donation

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

verification

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

DELETE DELETE /api/user/{userId}/verification

PATCH Changes verification status of one user to verified

GET GET /api/user/{userId}/verificationhistory

GET GET /api/user/{userId}/passhistory

POST User can create own passport

POST Ambassador can create passports for users in region

GET Returns the wallet URL for the current user

events

PATCH Updates the user's response to an invitation.

GET List events for region and groups.

POST Add a new event.

PATCH PATCH /api/events/{eventId}

featuretoggle

GET Returns all feature toggle identifiers with some information.

GET Checks if a feature toggle is active or not.

POST Toggles a feature toggle state.

foodSharePoints

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

DELETE DELETE /api/foodSharePoints/{foodSharePointId}

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 GET /api/foodSharePoints/{foodSharePointId}/permissions

POST POST /api/foodSharePoints/{foodSharePointId}/follow

DELETE DELETE /api/foodSharePoints/{foodSharePointId}/follow

POST POST /api/foodSharePoints/{foodSharePointId}/accept

foodsaver

GET Lists user agenda on a specific day, including pickups and events. The only works for future pickups and events.

forum

GET Gets available threads including their last post.

POST Create a thread inside a forum.

GET Get a single forum thread including some of its messages.

DELETE Deletes a forum thread.

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

POST Create a post inside a thread.

POST request email notifications for activities in at thread.

DELETE Remove email notifications for activities in a thread.

POST request bell notifications for activities in a thread.

DELETE Remove bell notifications for activities in a thread.

DELETE Delete a forum post.

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.

GET Get forum following status.

PATCH Set forum following status.

groups

DELETE Delete a region or a working group.

PATCH PATCH /api/groups/{groupId}

GET Returns the join URL of a given groups conference.

GET Returns a list of all groups of the user.

POST Adds a member to a working group.

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

POST Requests to join a group and provides motivation, ability, experience, and selected time message for mail to group.

my

GET Returns a list of all groups of the user.

GET Returns a list of all region of the user.

legal

PATCH Change privacy policy and privacy notice acknowledge.

GET Get legal page data

locale

GET Returns the locale setting for the current session.

POST Sets the locale for the current session.

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. This does not care about the previous status, i.e. setting a property to the same value as before will still result in a success response.

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

GET Returns all mails from mailbox.

GET Return mail from mailbox.

POST Send email from mailbox.

GET Returns all regions and their email addresses.

map

GET Returns the coordinates of all baskets.

GET Returns the data for the bubble of a community marker on the map.

GET Returns the data for a FoodSharePoint.

GET Returns the data for the bubble of a basket marker on the map.

GET Returns the data for the bubble of a store marker on the map.

GET Returns the data for the bubble of a event on the map.

GET Returns the data for the bubble of a user marker on the map.

conversation

POST POST /api/conversations/{conversationId}/readStatus

GET GET /api/conversations/{conversationId}/messages

POST POST /api/conversations/{conversationId}/messages

GET GET /api/conversations/{conversationId}

PATCH PATCH /api/conversations/{conversationId}

GET GET /api/conversations

POST POST /api/conversations

DELETE DELETE /api/conversations/{conversationId}/members/{userId}

GET GET /api/user/{userId}/conversation

newsletter

POST Sends a test newsletter email to the given address. Returns 200 on success, 401 if the current user may not send newsletters, or 400 if the email address is invalid.

notifications

GET Returns notifications for specific target parameter.

PATCH Update notification state for regions or working groups.

PATCH Set or disable notification for forum threads.

PATCH Set or disable notification for foodSharePoints.

PATCH Activate or disable the newsletter or mail notification for chat.

PATCH Activate or pickup reminder mail.

PATCH Activate or disable the mention notifications.

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}

DELETE DELETE /api/report/{reportId}

GET GET /api/user/names/{userIds}

GET Simple debug API returning server time and HTTPS flag.

petition

GET Returns possibly cached information of foodsharing petition at bundestag.

pickup

POST POST /api/stores/{storeId}/pickups/{pickupDate}/{fsId}

DELETE Remove a user from a pickup.

PATCH PATCH /api/stores/{storeId}/pickups/{pickupDate}/{fsId}

DELETE Remove a user from all his pickups.

GET Return the regular pickups for an store.

GET GET /api/stores/{storeId}/pickups

GET GET /api/stores/{storeId}/history/{fromDate}/{toDate}

GET Get past pickups of a user.

GET Get all future pickups a user has registered.

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

GET Validation of PickupRuleCheck.

stores

PUT Configures the regular pickups for a store.

PATCH Creates or modifies a manual pick up for an store.

GET GET /api/stores/meta-data

GET Returns a list of stores where the user is a member of reduced store information.

GET Provides store identifiers for stores of a region.

POST Creates a new store.

GET Provides store information, contacts and options for a store id.

PATCH Allows to patch the store with information like the store team status.

GET Provides store members.

GET Provides store permissions.

GET GET /api/user/{userId}/stores

GET GET /api/user/current/stores

GET Get applications to store team.

POST Request to join a store team.

DELETE Removes the user's own request or denies another user's request for a store.

PATCH Accepts a user's request for joining a store.

GET GET /api/stores/{storeId}/invitations

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

PATCH PATCH /api/stores/{storeId}/invitations

POST Invites a user to the store team, without a request to join from that user.

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

DELETE Removes user from store team.

DELETE Demotes a user from store manager to regular store team member.

PATCH Promotes a user to store manager.

DELETE Moves a store-team member from the standby team to the regular team.

PATCH Moves a store-team member from the regular team to the standby team.

GET Returns an array of log entries with foodsaver and log information.

DELETE Deletes a store.

pushnotification

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

POST Subscribes to push notifications with the specified handler

DELETE Subscribes to push notifications with the specified handler

quiz

POST POST /api/user/current/quizsessions/{quizId}/start

GET GET /api/user/current/quizsessions/{quizId}/status

GET GET /api/user/current/quizsessions/{quizId}/question

POST POST /api/user/current/quizsessions/{quizId}/answer

GET GET /api/user/current/quizsessions/{quizId}/results

POST POST /api/user/current/quizsessions/{quizId}/confirm

GET GET /api/quiz/sessions/{foodsaverId}

DELETE DELETE /api/quiz/session/{sessionId}

GET GET /api/quiz/{quizId}

PATCH PATCH /api/quiz/{quizId}

GET GET /api/quiz/{quizId}/questions

POST POST /api/quiz/{quizId}/questions

DELETE DELETE /api/quiz/{quizId}/questions/{questionId}

PATCH PATCH /api/quiz/{quizId}/questions/{questionId}

POST POST /api/quiz/{quizId}/questions/{questionId}/answers

DELETE DELETE /api/quiz/{quizId}/questions/{questionId}/answers/{answerId}

PATCH PATCH /api/quiz/{quizId}/questions/{questionId}/answers/{answerId}

region

POST POST /api/region/{regionId}/join

GET Returns a list of all region of the user.

POST Removes the current user from a region. Returns 403 if not logged in, 400 if the region does not exist, 409 if the user is still an active store manager in the region, or 200 if the user was removed from the region or was not a member of that region. That means that after a 200 result the user will definitely not be a member of that region anymore.

GET Returns the region options for a specific region.

POST Sets the options for region.

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

POST Sets the pin for 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 DELETE /api/region/{regionId}/members/{memberId}

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

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

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

GET Returns the properties of a specific region.

PATCH PATCH /api/region/{regionId}

POST Adds a region using the given data.

GET Returns the public region 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 Provides store identifiers for stores of a region.

report

GET GET /api/report/region/{regionId}

GET GET /api/report/user/{userId}

POST Adds a new report. The reportedId must not be empty.

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 that returns all kinds of searchable entry types.

GET Returns search index for quick local search of likely searched entities.

GET Search in the titles of forum threads in a specific group.

user

PATCH Sets the current users sleep mode.

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

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

PATCH Allows users to change their own password.

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

PATCH Enable or disable 2FA.

PATCH Enable or disable 2FA.

GET Load the user profile information.

GET Returns a list of stores where the user is a member of reduced store information.

GET GET /api/user/{userId}/stores

GET GET /api/user/current/stores

GET Checks if the user is logged in and lists the basic user information. Returns 200 and the user data, 404 if the user does not exist, or 401 if not logged in.

GET Checks if the user is logged in and lists the basic user information. Returns 401 if not logged in or 200 and the user data.

GET Lists the detailed profile of the current user. Returns 401 if not logged in or 200 and the data.

POST POST /api/user/login

POST POST /api/user/logout

POST Tests if an email address is valid for registration. Returns 400 if the parameter is not an email address or 200 and a 'valid' parameter that indicates if the email address can be used for registration.

POST Registers a new user.

DELETE DELETE /api/user/{userId}

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

DELETE Removes the user from the email bounce list. This will have no effect and return 200 if the user was not on the bounce list.

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.

statistics

GET Returns the gender distribution from a region.

GET Returns the age band distribution from a region.

GET Returns the age band distribution from a region.

GET Returns the age band distribution from a region.

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.

support

POST Creates a new support ticket

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

polls

GET Returns the details of a poll.

DELETE Deletes a poll.

PATCH Updates an existing poll. This can change a poll's title, description, and options. Updating is only possible within one hour after creation.

GET Lists all polls in a region or working group.

GET Lists all polls the user is invited to.

PUT Vote in a poll. The options need to be a list mapping option indices to the vote values (+1, 0, -1). Depending on the voting type not all options need to be included.

POST Creates a new poll. The poll and all its options will be assigned valid IDs and option indices by the server. Options must be passed as an array of strings for the options' texts. The order of the options will be kept.

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.

POST /api/admin/oauthclients

POST

/api/admin/oauthclients

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Responses

POST

/api/admin/oauthclients

Playground

Authorization

api_key

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Pager

Previous page GET GET /api/admin/oauthclients

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