Skip to content

List Projects

Endpoint

http
GET /unified/crm/projects
Integrations supported
  • Capsule
  • Planhat
  • Teamleader

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
name
string

The project's name

Supported in
  • Teamleader
status
string

The project's status

All possible enum values:
  • closed
  • open
  • over_budget
  • overdue
  • planned
  • running
Supported in
  • Teamleader
opportunity
array

The project's opportunity

Supported in
  • Teamleader
account
object

The project's account

Supported in
  • Teamleader
id
string

The account's unique identifier

name
string

The account name

contact
array

The project's contacts

Supported in
  • Teamleader
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • amount
  • created_at
  • name
  • updated_at
Enum support by integration
  • Teamleader
    • name
    • amount
  • Planhat
    • created_at
    • updated_at
    • name
Supported in
  • Planhat
  • Teamleader

Response Body

result
object[]

List of Projects

id
string
REQUIRED · 

The project's unique identifier

Supported in
  • Capsule
  • Planhat
  • Teamleader
name
string

The project's name

Supported in
  • Capsule
  • Planhat
  • Teamleader
description
string

The project's description

Supported in
  • Capsule
  • Teamleader
amount
number

The project's amount

Supported in
  • Planhat
  • Teamleader
currency
string

The amount attribute's currency

Supported in
  • Planhat
  • Teamleader
owner
object

The project's owner

Supported in
  • Capsule
  • Teamleader
id
string

The owner's unique identifier

name
string

The owner name

account
object

The project's account

Supported in
  • Planhat
  • Teamleader
id
string

The account's unique identifier

name
string

The account name

contact
object[]

The project's contacts

Supported in
  • Capsule
  • Teamleader
id
string

The contact's unique identifier

name
string

The contact name

opportunity
object[]

The project's opportunity

Supported in
  • Capsule
  • Teamleader
id
string

The opportunity's unique identifier

name
string

The opportunity name

stage
object

The project's stage

Supported in
  • Capsule
id
string

The stage's unique identifier

name
string

The stage's name

status
string

The project's status

Supported in
  • Capsule
  • Teamleader
tags
object[]

The project's tags

Supported in
  • Capsule
  • Teamleader
id
string

The tag's unique identifier

name
string

The tag's name

last_activity_at
string · date-time

The date and time of the project's last activity

Supported in
  • Capsule
close_date
string · date-time

The date and time of the project's close date

Supported in
  • Capsule
created_at
string · date-time

The date and time of the project's creation

Supported in
  • Capsule
  • Planhat
  • Teamleader
updated_at
string · date-time

The date and time of the project's last update

Supported in
  • Capsule
  • Planhat
  • Teamleader
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.