Skip to main content
GET
/
comments
/
read
Read comment by id
curl --request GET \
  --url https://api.obselite.com/v0/comments/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization": {},
  "team": {},
  "user": {},
  "parent": {},
  "children": [
    {}
  ],
  "resource": {},
  "task": {},
  "links": [
    {}
  ],
  "files": [
    {}
  ],
  "activities": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

The API token generated from the Obselite dashboard

Query Parameters

filter
string

Encoded JSON to search and refine lists, see filtering

include
string

Available options: parent, children, resource, task, links, files, activities

id
string<uuid>

Response

Successful response

id
string<uuid>
required

Comment UUID

content
string
required
userId
string<uuid>
required

Author User UUID

organization
object | null

The organization that owns this comment, following the organization schema

team
object | null

The team that this comment is associated with, following the team schema

user
object | null

The user who authored this comment, following the user schema

parent
object | null

The parent comment that this comment is replying to, following the comment schema

children
array
resource
object | null

The resource that this comment is associated with, following the resource schema

task
object | null

The task that this comment is associated with, following the task schema

files
array
activities
array