Organizations

Get a business

Public business profile. Accepts either the business's id (uuid) or its slug — the slug is what the public web profile is addressed by (/organizations/{slug}), so a client holding only a URL can resolve the business.

get/organizations/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/organizations/{id}
  • Auth: none declared

Path parameters

idstring required

Id (uuid) or slug of the record

Query parameters

includestring
Example:organization_roles.user

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: city, city.location, place, place.location, services, organization_roles, organization_roles.user.

Response

Successful. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "organization"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.