Clients

List Clients

The caller's client contact book, ordered by name. Pass owner_id/owner_type to read an organization's clients (requires edit rights on the organization). Pass q to search by name or location.

get/clients

Request

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

Query parameters

owner_idstring

Owner id to scope the list to (defaults to the current user).

owner_type'User' | 'Organization'

Owner type, "User" or "Organization".

qstring

Case-insensitive search over client name and location.

pageinteger

Select within paginated results

per_pageinteger

Number results to return

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

Clients for the requested owner. 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 5 revisions of this API.