Clients

Get a client contact by ID

Retrieve one saved client contact by its PurpleGrain client ID. Returns its name, mobile, email, location, task count and last task date; include can expand its owner or linked user. Requires permission to manage the owning account or organization, including write access in an assistant connection's grant. This lookup does not modify the contact or send messages.

get/clients/{id}

Request

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

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:owner

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: owner, 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": "client"
  }
}

Changes

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