Get a user profile by public handle

Retrieve one existing user's profile using the handle from their public PurpleGrain profile address. Returns their name, about text, avatar URLs and contact or account fields visible to the caller. Use include to expand services or place and location details. Returns not found for an unknown handle. This lookup does not change the profile or contact the user.

get/users/handle

Request

Base URL: https://api.purplegrain.com/api/v1
URL: https://api.purplegrain.com/api/v1/users/handle
Auth: none declared

Query parameters

handlestring required

The user's handle (slug).

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.