Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Human Services Data Meta API (V2.0)
Introduction
Metadata
Metatable

Human Services Data Meta API (V2.0)

This is a specification describing the Human Services Data API, using the Human Services Data Specification (HSDS). This has been extracted from the Ohana API deployment, but will be standardized to refer to the universal standard that will apply to any HSDS/A compliant API.

Contact Support: Name: Open Referral Email: info@openreferral.org

Metadata

GETGet Metadata

{{hsda_base_url}}/metadata/:metadata_id/

Returns a single metadata entry

PATH VARIABLES
metadata_id

<string>

(Required) The metadata id.

GETGet Metadata

{{hsda_base_url}}/metadata/?query=<string>&fields=<string>&page=<number>&per_page=<number>&sort_by=<string>&order=<string>&format=<string>

Returns a list of all metadata.

PARAMS
query

<string>

A query to filter list by (up to provider to determine what to search)

fields

<string>

A list of fields to be returned with the response, if not included, all are returned.

page

<number>

The particular page of results.

per_page

<number>

Number of records to return per page, up to 100.

sort_by

<string>

Which field to sort by.

order

<string>

Which order to sort by (asc,desc).

format

<string>

The data format of the response (csv, json, xml).

Loading