Skip to content

Search index for quick local search of likely searched entities​

GET
/api/search/index

Authorizations​

api_key

Requests manipulating data need to supply a CSRF token

Type
API Key (header: X-CSRF-Token)

Responses​

Success

application/json
JSON
{
  
"regions": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"email": "muenster@foodsharing.network",
  
  
  
"parentId": 42,
  
  
  
"parentName": "Nordrhein-Westfalen",
  
  
  
"isMember": true,
  
  
  
"ambassadors": [
  
  
  
  
{
  
  
  
  
  
"id": 342528,
  
  
  
  
  
"name": "Franzi",
  
  
  
  
  
"avatar": "99d1fb45-9748-3510-ac02-87b46c40048c",
  
  
  
  
  
"isSleeping": null
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"workingGroups": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"email": "bildung.muenster@foodsharing.network",
  
  
  
"parentId": 1,
  
  
  
"parentName": "Münster",
  
  
  
"isMember": true,
  
  
  
"isAdmin": true,
  
  
  
"admins": [
  
  
  
  
{
  
  
  
  
  
"id": 342528,
  
  
  
  
  
"name": "Franzi",
  
  
  
  
  
"avatar": "99d1fb45-9748-3510-ac02-87b46c40048c",
  
  
  
  
  
"isSleeping": null
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"stores": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"cooperationStatus": 5,
  
  
  
"street": "Oskar-Michels-Ring 29",
  
  
  
"zipCode": "48163",
  
  
  
"city": "Münster",
  
  
  
"regionId": 1,
  
  
  
"regionName": "Münster",
  
  
  
"membershipStatus": 1,
  
  
  
"isManager": true,
  
  
  
"chainName": "string"
  
  
}
  
],
  
"foodSharePoints": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"street": "Oskar-Michels-Ring 29",
  
  
  
"zipCode": "12345",
  
  
  
"city": "Münster",
  
  
  
"regionId": 1,
  
  
  
"regionName": "Münster"
  
  
}
  
],
  
"chats": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"lastMessageSentAt": "string",
  
  
  
"lastFoodsaverId": 51,
  
  
  
"lastFoodsaverName": "Max",
  
  
  
"lastMessage": "Have a nice day!",
  
  
  
"members": [
  
  
  
  
{
  
  
  
  
  
"id": 342528,
  
  
  
  
  
"name": "Franzi",
  
  
  
  
  
"avatar": "99d1fb45-9748-3510-ac02-87b46c40048c",
  
  
  
  
  
"isSleeping": null
  
  
  
  
}
  
  
  
],
  
  
  
"memberCount": 12
  
  
}
  
],
  
"threads": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"lastPostSentAt": "string",
  
  
  
"pinnedLevel": 1,
  
  
  
"isClosed": true,
  
  
  
"isInsideAmbassadorForum": true,
  
  
  
"postId": 42,
  
  
  
"regionId": 0,
  
  
  
"regionName": "Münster",
  
  
  
"body": "This is the body of the thread",
  
  
  
"relevance": 0.85
  
  
}
  
],
  
"users": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"avatar": "string",
  
  
  
"lastName": "Mustermann",
  
  
  
"mobile": "+49 1234 56789",
  
  
  
"isBuddy": true,
  
  
  
"isVerified": true,
  
  
  
"regionId": 0,
  
  
  
"regionName": "Münster",
  
  
  
"email": "max@mustermann.com"
  
  
}
  
],
  
"mails": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"senderMail": "sender@example.com",
  
  
  
"senderName": "Sender",
  
  
  
"recipientMail": "developer@foodsharing.network",
  
  
  
"recipientName": "foodsharing Developer",
  
  
  
"recipientCount": "3",
  
  
  
"hasAttachments": true,
  
  
  
"sentAt": "2023-10-04 15:21:52",
  
  
  
"folder": 1
  
  
}
  
],
  
"events": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"locationName": "foodsharing Developer",
  
  
  
"status": "1",
  
  
  
"startAt": "string",
  
  
  
"endAt": "string",
  
  
  
"locationType": 1,
  
  
  
"regionId": 1,
  
  
  
"regionName": "Münster"
  
  
}
  
],
  
"polls": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Name",
  
  
  
"searchString": "Münster;meunster",
  
  
  
"startAt": "2023-10-04 15:21:52",
  
  
  
"endAt": "2023-10-04 15:21:52",
  
  
  
"regionId": 1,
  
  
  
"regionName": "Münster",
  
  
  
"hasVoted": true
  
  
}
  
]
}

Playground​

Authorization

Samples​