Get all projects

GET 
/projects

Get all projects

Request

Query Parameters

name string

Search for projects by name

gameEngine string

Search for projects by engine

platform string

Search for projects by platform

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, numMonthlyUsers, name]

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

Projects successfully retrieved

application/json

Schema

Schema

• Array [

gameEngine string

Possible values: <= 50 characters

The game engine used for the project

name projectName (string)required

Possible values: <= 32 characters

Name of the project

hidden boolean

Indicates if the project is hidden or visible

thumbnail urinullable

URL to the project's thumbnail image

ownerId

Unique identifier of the owner

config objectnullable

Configuration settings for the project

id string

Unique identifier for Project

platform string

Platform for the project

createdAt date-time

Time representation of Project creation

numMonthlyUsers integer

Number of monthly users

• ]

Example (from schema)

[
  {
    "gameEngine": "Unity",
    "name": "Call of foodie 2",
    "hidden": false,
    "thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
    "ownerId": "ab1a4ade-6eb9-40cd-bb3e-f274af238649",
    "config": "https://file.playmakers.co/cfg/p2Duhf5N6/config.json",
    "id": "p2Duhf5N6",
    "platform": "[\"pc\",\"linux\", \"xbox\", \"playstation\"]",
    "createdAt": "2024-01-01T09:00:00.00Z",
    "numMonthlyUsers": 1500
  }
]

Example

[
  {
    "name": "Among Sus",
    "gameEngine": "Unity",
    "hidden": false,
    "platform": "[\"pc\",\"playstation\"]",
    "id": "phGw7yOHR",
    "config": "https://file.playmakers.co/cfg/phGw7yOHR/config.json",
    "ownerId": "36ef1a29-f2bf-4ee5-bc3e-22ab393301d2",
    "members": [
      {
        "avatar": "https://file.playmakers.co",
        "cognitoUserId": "d0186a63-38a8-49bc-b582-404a65b6f468",
        "name": "Latifa"
      },
      {
        "name": "Marwan",
        "avatar": "https://file.playmakers.co",
        "cognitoUserId": "f00a7969-1395-479b-8b07-4d5e582a9187"
      }
    ],
    "thumbnail": "https://file.playmakers.co/phGw7yOHR/aHkifyM28.jpg",
    "numMonthlyUsers": 1000,
    "createdAt": "2024-01-01T08:00:00.000Z"
  },
  {
    "gameEngine": "UnrealEngine",
    "name": "Underwatch",
    "hidden": false,
    "id": "phT3dYzBs",
    "platform": "[\"xbox\", \"playstation\"]",
    "thumbnail": "https://file.playmakers.co/phT3dYzBs/aUOZTirea.jpg",
    "ownerId": "0a83e048-171a-4c3a-87b7-e9313a198ec8",
    "config": "https://file.playmakers.co/cfg/phT3dYzBs/config.json",
    "members": [
      {
        "cognitoUserId": "fa4a03dc-1edd-4ad2-b635-49e2f39f6847"
      },
      {
        "cognitoUserId": "2fe7a3d7-b1b9-487d-ab64-288a9dc1475d"
      }
    ],
    "numMonthlyUsers": 5050,
    "createdAt": "2024-01-01T08:00:00.000Z"
  }
]

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden 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...