List locations
curl --request GET \
--url https://api.hfsaa.org/v1/locations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hfsaa.org/v1/locations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hfsaa.org/v1/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hfsaa.org/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hfsaa.org/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hfsaa.org/v1/locations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hfsaa.org/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_version": "<string>",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "restaurant",
"name": "Example Restaurant",
"verification_url": "https://hfsaa-public-locator.pages.dev/?certificate_id=HFSAA-R-EXAMPLE",
"certification_status": "certified",
"chapter_name": "New York",
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"cuisine_type": "Mediterranean",
"google_place_id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA"
}
],
"pagination": {
"limit": 25,
"next_cursor": "<string>"
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}Locations
List locations
Returns HFSAA-certified directory locations across all supported types.
GET
/
v1
/
locations
List locations
curl --request GET \
--url https://api.hfsaa.org/v1/locations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hfsaa.org/v1/locations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hfsaa.org/v1/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hfsaa.org/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hfsaa.org/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hfsaa.org/v1/locations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hfsaa.org/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_version": "<string>",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "restaurant",
"name": "Example Restaurant",
"verification_url": "https://hfsaa-public-locator.pages.dev/?certificate_id=HFSAA-R-EXAMPLE",
"certification_status": "certified",
"chapter_name": "New York",
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"cuisine_type": "Mediterranean",
"google_place_id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA"
}
],
"pagination": {
"limit": 25,
"next_cursor": "<string>"
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}Authorizations
Use the API key as Authorization: Bearer <api-key>.
Query Parameters
Restrict results to a location type.
Available options:
restaurant, meat_market, dining_hall Filter by two-letter U.S. state or territory code.
Required string length:
2Example:
"NY"
Filter by city name.
Example:
"New York"
Filter by ZIP or postal code.
Example:
"10001"
Filter by chapter name.
Example:
"New York"
Search location names and directory fields.
Maximum string length:
100Example:
"halal grill"
Maximum number of results returned in one page.
Required range:
1 <= x <= 100Opaque, dataset-version-bound cursor returned by a prior list response. Keep the same filters when requesting the next page. Superseded versions remain available for at least seven days; an expired cursor returns HTTP 410.