Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The project ID.

Minimum string length: 1

Response

OK

id
string
required

The project ID.

Minimum string length: 1
name
string
required

Project name.

Minimum string length: 1
access
object
required

Who can see the project: everyone in the organization, or only its members.

accounts
object[]
required

The accounts linked to the project. Direct links only: the accountId filter on the project list also matches projects linked through one of the account's contacts.

contacts
object[]
required

The contacts linked to the project.

createdAt
string<date-time>
required

When the project was created.

updatedAt
string<date-time>
required

When the project was last updated, including changes to its linked accounts and contacts. Field value changes do not change it.

fields
object
required

Custom field values, keyed by field name, with a key for every field defined for projects (null when unset). The value's shape follows the field's type.