Get a comment

curl --request GET \
  --url https://api.attio.com/v2/comments/{comment_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "content_plaintext": "Let's go ahead and close this deal, [email protected].",
    "entry": {
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "record": {
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "resolved_at": "2023-01-01T15:00:00.000000000Z",
    "resolved_by": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2023-01-01T15:00:00.000000000Z",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    }
  }
}

GET

comments

{comment_id}

Get a comment

curl --request GET \
  --url https://api.attio.com/v2/comments/{comment_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "content_plaintext": "Let's go ahead and close this deal, [email protected].",
    "entry": {
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "record": {
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "resolved_at": "2023-01-01T15:00:00.000000000Z",
    "resolved_by": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2023-01-01T15:00:00.000000000Z",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    }
  }
}

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

comment_id

string<uuid>

required

A UUID which identifies the comment.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

Response

Success

data

object

required

Show child attributes

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

The ID of the workspace the comment belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.comment_id

string<uuid>

required

The ID of the comment.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

data.thread_id

string<uuid>

required

The ID of the thread the comment belongs to.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

data.content_plaintext

string

required

A plaintext representation of the content of the comment. References to workspace members are cast into email addresses, all other stylistic elements are removed.

Example:

"Let's go ahead and close this deal, [email protected]."

data.entry

object

required

The entry the comment belongs to, null for comments on records.

Show child attributes

data.entry.entry_id

string<uuid>

required

The ID of the entry the comment belongs to.

Example:

"2e6e29ea-c4e0-4f44-842d-78a891f8c156"

data.entry.list_id

string<uuid>

required

The ID of the list the entry belongs to.

Example:

"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"

data.record

object

required

The record the comment belongs to.

Show child attributes

data.record.record_id

string<uuid>

required

The ID of the record the comment belongs to.

Example:

"bf071e1f-6035-429d-b874-d83ea64ea13b"

data.record.object_id

string<uuid>

required

The ID of the object the record belongs to.

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.resolved_at

string | null

required

Whether the comment is resolved.

Example:

"2023-01-01T15:00:00.000000000Z"

data.resolved_by

object

required

The actor that resolved this comment.

Show child attributes

data.resolved_by.id

string | null

An ID to identify the actor.

data.resolved_by.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.created_at

string

required

When the note was created.

Example:

"2023-01-01T15:00:00.000000000Z"

data.author

object

required

Who wrote this comment. Note that the API provides the ability for API tokens to write comments on behalf of other actors.

Show child attributes

data.author.id

string | null

An ID to identify the actor.

data.author.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

Create a comment Delete a comment

⌘I

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Get a comment

Authorizations

Path Parameters

Response