GET
/
v1
/
teams
/
{teamId}
/
posts
/
{postId}
/
notes
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.postNotes.listPostNotes({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  postId: process.env.OCTOSPARK_POST_ID ?? "postId",
})
{
  "data": [
    {
      "mentionedUserIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "postId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "body": "<string>",
      "bodyDoc": [
        "<unknown>"
      ],
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "authorName": "<string>",
      "authorEmail": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

​
postId
string
required

Post id (UUID), as returned by the create post and list posts endpoints.

Response

Success

​
data
object[]
required