Resolve organization details publicly by slug, id, or partnerId

GET

/api/organizations/public

const url = 'https://example.com/api/organizations/public';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/organizations/public

Parameters

Query Parameters

slug

string

string format: uuid

partnerId

string format: uuid

Responses

200

Public organization details

application/json

object

required

Unique identifier (UUID v4) for the resource.

string format: uuid

name

required

Full display name of the resource, facility, or individual.

string

slug

required

URL-friendly unique slug identifier.

string

shortCode

Unique 4 to 6 character uppercase short code.

string

defaultPartnerId

required

Unique identifier (UUID v4) for the default fallback partner location.

string format: uuid

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "name": "Community Food Pantry",
  "slug": "hope-community-center",
  "shortCode": "DCC",
  "defaultPartnerId": "20000000-0000-0000-0000-000000000002"
}

400

Missing query parameter or invalid format

404

Organization not found