Get comments for submissionId

GET 
/comments/:submissionId

Get comments for submissionId

Request

Path Parameters

submissionId submissionIdrequired

The submissionId to get comments for

Query Parameters

content string

Search for comments by content

state string

Search for comments by state

startDate date-time

Search by start date

endDate date-time

Search by end date

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of projects per page (default is 10, 0 gets all results).

sortBy string

Possible values: [createdAt, content]

Field to order the results by (e.g., 'createdAt', 'numMonthlyUsers'). Default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

Comments retrieved

application/json

Schema

Schema

• Array [

createdAt date-time

Time representation of entity creation

body string
state commentState (string)

Possible values: [public, hidden, flagged, studioApproved, studioRejected]

owner address (string)
id commentId (string)

Unique identifier for Comment

submissionId submissionId (string)

Unique identifier for Project

• ]

Example (from schema)

[
  {
    "createdAt": "2024-01-01T09:00:00.00Z",
    "body": "string",
    "state": "public",
    "owner": "string",
    "id": "cCX5ZZHMk",
    "submissionId": "S14dqdbbnC"
  }
]

Example

[
  {
    "state": "public",
    "body": "This is a comment",
    "submissionId": "6c3f1178-3x45-3ec4-bac3-205026484a7e",
    "id": "35c4407b-6bca-4178-ac77-6dd7889fv703",
    "createdAt": "2024-02-01T20:15:00.000Z",
    "ownerId": "5d4f3111-4x21-4e3c-bac3-452164484b9c"
  }
]

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...