Skip to content

Get Projects

Endpoint

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

Path parameters

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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

Response Body

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.