Users

Get a PurpleGrain user profile by ID

Retrieve one existing user's profile using their PurpleGrain user ID. Returns their name, about text, handle, avatar URLs and the contact or account fields visible to the caller under the profile's visibility rules. Use include to expand services or place and location details. This lookup does not change the profile or send a message to the user.

get/users/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/users/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the record

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

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

Changes

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