Get submissions

GET 
/submissions

Get submissions

Request

Query Parameters

ownerId string

Owner ID

projectId string

Project ID

schemaId string

Schema ID

state string[]

Search for submission by state

name string

Search for submission by name

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).

orderBy string

Possible values: [createdAt, name, state, popularity, trending, voteCount, commentCount]

Field to order the results by (e.g., 'createdAt', 'ownerId'). 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

Submission successfully retrieved

application/json

Schema

Schema

• Array [

creatorDisplayThumbnailData string

Thumbnail data

id string

Unique submission identifier

ownerId string

Unique identifier of the owner

description string

Submission description

state string

Possible values: [draft, pendingValidation]

State in which the submission is

commentCount integer

Integer representing amount of comments on submission

thumbnail string

Thumbnail image relative to the submission

source string

Submission source

createdAt date-time

Submission creation time

schemaId stringrequired

Unique identifier for Schema

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

voteCount integer

Integer representing amount of votes on submission

postTitle string

Submission title

computation string

Computation technique

data string

Structural data about the submission

• ]

Example (from schema)

[
  {
    "creatorDisplayThumbnailData": "",
    "id": "S1gf0qsVq",
    "ownerId": "ab1a4ade-6eb9-40cd-bb3e-f274af238649",
    "description": "This is a new submission for a facepaint",
    "state": "draft",
    "commentCount": 0,
    "thumbnail": "https://file.playmakers.co/S1gf0qsVq/thumbnail.png",
    "source": "",
    "createdAt": "2024-09-11T10:30:56.168Z",
    "schemaId": "s2S7KuFGc",
    "name": "Screaming Facepaint",
    "voteCount": 0,
    "postTitle": " Code face paint for the latest release",
    "computation": "default",
    "data": "{\"schema\":\"facepaint\",\"children\":{\"albedo\":{\"schema\":\"albedo\",\"image\":\"https://file.playmakers.co/S1gf0qsVq/data/facepaint.png\"}}}"
  }
]

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

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

Loading...