Get project details

GET 
/project/:projectId

Get project details

Request

Path Parameters

projectId projectIdrequired

The projectId to get data of

Responses

200

Project successfully retrieved

application/json

Schema

Schema

config objectnullable

Configuration settings for the project

id string

Unique identifier for Project

credits integer

The amount of project credits available.

createdAt date-time

Time representation of Project creation

platform string

Platform for the project

name projectName (string)required

Possible values: <= 32 characters

Name of the project

thumbnail urinullable

URL to the project's thumbnail image

numMonthlyUsers integer

Number of monthly users

ownerId

Unique identifier of the owner

hidden boolean

Indicates if the project is hidden or visible

gameEngine string

Possible values: <= 50 characters

The game engine used for the project

members

object[]

Array [

cognitoUserId string

name string

avatar url

]

Example (from schema)

{
  "config": "https://file.playmakers.co/cfg/p2Duhf5N6/config.json",
  "id": "p2Duhf5N6",
  "credits": 100,
  "createdAt": "2024-01-01T09:00:00.00Z",
  "platform": "[\"pc\",\"linux\", \"xbox\", \"playstation\"]",
  "name": "Call of foodie 2",
  "thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
  "numMonthlyUsers": 1500,
  "ownerId": "ab1a4ade-6eb9-40cd-bb3e-f274af238649",
  "hidden": false,
  "gameEngine": "Unity",
  "members": [
    {
      "cognitoUserId": "170596c9-a3aa-4264-98ec-803799d5fc15",
      "name": "Marwan",
      "avatar": "https://file.playmakers.co"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

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

Loading...