Accounts

Get an account

Get a single account (client organization) by ID.

get/accounts/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/accounts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The account ID.

Response

OK

idstring required

The account ID.

namestring required

Account name.

contactCountinteger required

How many contacts belong to the account. List them by filtering contacts by accountId.

projectCountinteger required

How many projects you can see are linked directly to the account. Filtering projects by accountId also returns the projects linked through the account's contacts. Linking or unlinking a project doesn't change the account's updatedAt.

createdAtstring date-time required

When the account was created.

updatedAtstring date-time required

When the account itself was last updated. Contacts joining or leaving the account, links to projects, and field value changes do not change it.

fieldsobject required

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

Example response

{
  "id": "cmf2x7r1p0000abcd",
  "name": "Acme Corp",
  "contactCount": 3,
  "projectCount": 2,
  "createdAt": "2026-09-12T10:00:00.000Z",
  "updatedAt": "2026-09-12T10:00:00.000Z",
  "fields": {
    "Web Address": [
      "acme.example"
    ],
    "Overview": null
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.