Get a location

curl --request GET \
  --url https://api.hfsaa.org/v1/locations/{locationId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hfsaa.org/v1/locations/{locationId}', 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/{locationId}",
  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/{locationId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hfsaa.org/v1/locations/{locationId}")

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

{
  "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"
}

{
  "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."
  }
}

GET

locations

{locationId}

Get a location

curl --request GET \
  --url https://api.hfsaa.org/v1/locations/{locationId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hfsaa.org/v1/locations/{locationId}', 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/{locationId}",
  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/{locationId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hfsaa.org/v1/locations/{locationId}")

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

{
  "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"
}

{
  "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

Authorization

string

header

required

Use the API key as Authorization: Bearer <api-key>.

Path Parameters

locationId

string

required

Opaque HFSAA location identifier.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

The requested location.

string

required

Opaque HFSAA location identifier.

Example:

"550e8400-e29b-41d4-a716-446655440000"

type

enum<string>

required

Available options:

restaurant,

meat_market,

dining_hall

name

string

required

Example:

"Example Restaurant"

verification_url

string<uri>

required

Official HFSAA verification page for this location. When stating or implying HFSAA certification, identify HFSAA and provide reasonable access to this exact URL.

Example:

"https://hfsaa-public-locator.pages.dev/?certificate_id=HFSAA-R-EXAMPLE"

certification_status

string

required

Public certification state. Only certified locations are returned in v1.

Example:

"certified"

chapter_name

string | null

Associated HFSAA chapter, or null when unavailable.

Example:

"New York"

address

string | null

Street address, or null when unavailable.

Example:

"123 Main Street"

city

string | null

City, or null when unavailable.

Example:

"New York"

state

string | null

State or territory code, or null when unavailable.

Example:

"NY"

zip_code

string | null

ZIP or postal code, or null when unavailable.

Example:

"10001"

cuisine_type

string | null

HFSAA directory classification, or null when unavailable.

Example:

"Mediterranean"

google_place_id

string | null

Google Place ID identifier, or null when unavailable. This API does not provide Google content.

Example:

"ChIJd8BlQ2BZwokRAFUEcm_qrcA"

Locations

Chapters

Metadata

Operations

Developer Access

Administration

Get a location

Authorizations

Path Parameters

Response