List Page Comments

GET

/pages/{pageId}/comments

curl --request GET \
  --url 'https://app.metakip.com/api/v1/pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/comments?status=open&limit=50' \
  --header 'Authorization: Bearer <token>'

• Hosted Metakip API
• Relative to the current Metakip server.

Authorizations

• bearerToken
• browserSession

Parameters

Path Parameters

pageId

required

string format: uuid

The UUID of the page.

Query Parameters

status

string

default: open

Allowed values: open resolved all

Filter by thread status. Defaults to open.

cursor

string

Cursor returned by a previous list response.

limit

integer

default: 50 >= 1 <= 100

Number of threads to return. Defaults to 50 and cannot exceed 100.

Responses

200

The requested comment data.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

pageId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

anchor

required

object

quote

required

string

>= 1 characters <= 100000 characters

prefix

Any of:

string

string

<= 200 characters

null

null

suffix

Any of:

string

string

<= 200 characters

null

null

status

required

string

Allowed values: open resolved

createdBy

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

createdAt

required

string

updatedAt

required

string

resolvedBy

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

resolvedAt

required

Any of:

string

string

null

null

comments

required

Array<object>

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

threadId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

authorId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

authorName

required

Any of:

string

string

null

null

authorImage

required

Any of:

string

string

null

null

body

required

Any of:

string

string

null

null

createdAt

required

string

updatedAt

required

string

deletedAt

required

Any of:

string

string

null

null

nextCursor

required

Any of:

string

string

null

null

Example

{
  "data": [
    {
      "status": "open"
    }
  ]
}

403

The API token is missing a required scope: pages:comment.

Media typeapplication/json

Structured error returned when the request cannot be completed.

object

error

required

Error details for programmatic handling.

object

code

required

Stable error code.

string

message

required

Human-readable explanation.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}