Relationships

By default, an endpoint returns a resource’s own attributes. Use include to embed related resources in the response and append to add computed attributes. Each endpoint documents the relationships and attributes it supports.

Includes

Embed a related resource with the include parameter. Include multiple relationships by separating them with commas.

curl "https://api.contractorscloud.com/api/v1/users?include=user_level,default_company" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Each included relationship is nested under the resource in the response:

{
  "id": 1159,
  "first_name": "Jane",
  "user_level": { "id": 4, "name": "Administrator" },
  "default_company": { "id": 6, "name": "Acme Construction" }
}

Includes cover to-one relationships, such as the company a user belongs to. To retrieve a resource’s collection of related records, a company’s projects for example, use that resource’s dedicated list endpoint instead.

Extended properties are an exception: contacts, users, and other supported resources let you include extended_properties to embed all of a resource’s custom key/value metadata in one call — see Extended properties.

Appends

Some attributes are computed on demand rather than returned by default. Add them with the append parameter, comma-separated for multiple values.

curl "https://api.contractorscloud.com/api/v1/users?append=home_page,needs_onboarding" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Appended attributes appear alongside the resource’s own attributes in the response.

Request only the includes and appends you need. Each one adds work to the response, so keeping them minimal keeps responses fast.

Getting Started

Reference

Includes

Appends

​Includes

​Appends

Includes

Appends