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

id string

Unique identifier for Project

ownerId

Unique identifier of the owner

gameEngine string

Possible values: <= 50 characters

The game engine used for the project

numMonthlyUsers integer

Number of monthly users

createdAt date-time

Time representation of Project creation

thumbnail urinullable

URL to the project's thumbnail image

name projectName (string)required

Possible values: <= 32 characters

Name of the project

hidden boolean

Indicates if the project is hidden or visible

config objectnullable

Configuration settings for the project

platform string

Platform for the project

members

object[]

Array [

name string

cognitoUserId string

avatar url

]

Example (from schema)

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