User For Session

The signed-in user. Start here when looking up a property: take this user's id to listOrganizationRoles (with include=organization) for the businesses they belong to, then listFarms with no organization_id for personal properties and with each organization_id for a business's.

get/users/fetch-current-user

Request

Base URL: https://api.purplegrain.com/api/v1
URL: https://api.purplegrain.com/api/v1/users/fetch-current-user
Auth: HTTP bearer

Query parameters

includestring

Example:services

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, location, services.

Response

Success. 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": "user"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.