Organization Roles

Organization Roles

Memberships. With user_id set to the signed-in user (fetchCurrentUser) and include=organization, this is the businesses that user belongs to and the permission on each (owner, manager, and the rest). A business's properties are listFarms with that organization's id; they are not in the personal farm list.

get/organization-roles

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/organization-roles
  • Auth: none declared

Query parameters

user_idstring

The user whose memberships to list. Use the id from fetchCurrentUser, with include=organization, to find the businesses that user belongs to.

pageinteger

Select within paginated results

per_pageinteger

Number results to return

includestring
Example:organization

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: organization, 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_role"
    }
  ]
}

Changes

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