Users

Look up user profiles by IDs or email addresses

Look up existing user profiles using filter[id][] or filter[email][]. Requires authentication and returns an empty list when no filter is supplied; an email filter takes precedence when both arrays are supplied. Returns profile fields visible to the caller, with optional included services or place details. Use page and per_page, following meta.next_page. This lookup does not change accounts or send messages.

get/users

Request

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

Query parameters

pageinteger

Select within paginated results

per_pageinteger

Number results to return

filter[id][]string[]

Filter returned results on ids

filter[email][]string[]

Filter returned results on emails

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 2 revisions of this API.