LikedContractors

List Liked Contractors

The caller's liked contractors (most recent first). Pass owner_id/owner_type to read an organization's list (requires edit rights on the organization). Pass contractor_id/contractor_type to answer "is this contractor liked?".

get/liked-contractors

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/liked-contractors
  • 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".

contractor_idstring

Filter to a single contractor (liked-state lookup).

contractor_type'User' | 'Organization'

Contractor type, "User" or "Organization".

pageinteger

Select within paginated results

per_pageinteger

Number results to return

includestring
Example:contractor

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, contractor.

Response

Liked contractors 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": "liked_contractor"
    }
  ]
}

Changes

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