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 [

postTitle string

Submission title

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

voteCount integer

Integer representing amount of votes on submission

thumbnail string

Thumbnail image relative to the submission

createdAt date-time

Submission creation time

commentCount integer

Integer representing amount of comments on submission

data string

Structural data about the submission

creatorDisplayThumbnailData string

Thumbnail data

source string

Submission source

description string

Submission description

state string

Possible values: [draft, pendingValidation]

State in which the submission is

schemaId stringrequired

Unique identifier for Schema

ownerId string

Unique identifier of the owner

computation string

Computation technique

id string

Unique submission identifier

• ]

Example (from schema)

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

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

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

Loading...