List All Projects

You can view all your projects by sending a GET request to the /project endpoint.

List all projects

GET https://api.playfix.io/project/projects

Get the details of all your projects.

Query Parameters

Name

Type

Description

pageSize

Integer

Max number of projects to return in a single page. Each response will contain one page. This can be any number from 1 to 100.

pageToken

String

Page token for next page. You can get this value from the nextPageToken field of a prior response.

Headers

Name

Type

Description

Authorization*

String

The access token you get from the authorization process.

Example:

Bearer <your_access_token>en>

{
  "projects": [
    {
      "name": "projects/01g3q945mbbn6dxm4jbwdr82ag",
      "title": "Block Party1",
      "description": "A good block party game",
      "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }
  ],
  "nextPageToken": "projects/01g3q945mbbn6dxm4jbwdr82ag"
}

Example cURL API Call

curl --request GET \
  --url https://api.playfix.io/project/projects \
  --header 'Authorization: Bearer <your_access_token>'

Example Python API Call

import requests

r = requests.get(
    "https://api.playfix.io/project/projects",
    headers = {
        "Authorization": "Bearer <your_access_token>"
        }
    )

print(r.text)

Response Body

{
  "projects": [
    {
      "name": "projects/01g3q945mbbn6dxm4jbwdr82ag",
      "title": "Block Party1",
      "description": "A good block party game",
      "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }
  ],
  "nextPageToken": "projects/01g3q945mbbn6dxm4jbwdr82ag"
}

The list of your projects will be under projects in the response. The projects key contains an array of project objects. Right now, the only project in the list should be your newly created project. You will see each project as an object in the projects array if you have created multiple projects.

Response fields

The projects key of the response contains an array of objects. Each object represents a single project with the following fields:

name - The name that uniquely identifies the project.
title - The title of the project.
description - A short description of the project.
imageCoverUrl - The automatically generated URL for the cover image.
imageCoverCid - The IPFS CID of the cover image.

If you have more than 10 projects, the response will include an additional nextPageToken.

Response Body

{
  "projects": [
    {
      "name": "projects/01g3q945mbbn6dxm4jbwdr82ag",
      "title": "Block Party1",
      "description": "A good block party game",
      "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    },
    {
      "name":"projects/01gek5939bqgxqq3n1bng2t104", 
      "title":"Dinger", 
      "description":"An interesting home run game", 
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe", 
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    }, 
    {
      "name":"projects/01gf83ma2wqyqd8g3adsfnywhv",
      "title":"Hey hey",
      "description":"A great synthesis game",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe",
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    },
    {
      "name":"projects/01gf8c3v23q7xcvb6hpfexphq4",
      "title":"Fury Master",
      "description":"A game for the wild",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe", 
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    },
    {
      "name":"projects/01gf8cs52nw99fbj2bj7dhw99w",
      "title":"Jungle Rico", 
      "description":"Nice game", 
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe",
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    }, 
    {
      "name":"projects/01gfanyhg3ygtqw4capw5pt5d9",
      "title":"Block Party2",
      "description":"Yet another good block party game",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid":"QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }, 
    {
      "name":"projects/01gfav9m1c4zd6eq154th2pafz",
      "title":"Dusk to Dawn",
      "description":"A game that gives you all the trills",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid":"QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    },
    {
      "name":"projects/01gfd8f6w7bzm10x0z4wxm1cqh",
      "title":"Alchemy",
      "description":"Test your physlosophycal ability",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe",
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    }, 
    {
      "name":"projects/01gfd8fbfbw2agw0ee497qa9ke",
      "title":"Aqua Fury",
      "description":"Water game",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid":"QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }, 
    {
      "name":"projects/01gfd8h1r19wkpze7fj47cdzm7",
      "title":"Within Us",
      "description":"A great game to improve intution",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe",
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    },
    {
      "name":"projects/01gfd8h1r19wkpze7fj47cdzm7",
      "title":"Green Yard",
      "description":"A game that supports green energy",
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid":"QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }
  ],
  "nextPageToken": "projects/01gfd8h1r19wkpze7fj47cdzm7"
}

Paging

By default, the projects GET request returns a page containing ten projects at a time. If you have more than ten projects, you can view the next page using the nextPageToken as the value of the pageToken parameter.

Example cURL API Call

curl --request GET \
  --url 'https://api.playfix.io/project/projects?pageToken=<your_nextPageToken>' \
  --header 'Authorization: Bearer <your_access_token>'

Example Python API Call

import requests

r = requests.get(
    "https://api.playfix.io/project/projects",
    params = {
        "pageToken": "<your_nextPageToken>"
        },
    headers = {
        "Authorization": "Bearer <your_access_token>"
        }
    )

print(r.text)

This will return the next page containing your other projects.

Reaching the Last Page

When you reach the last page of your projects, the nextPageToken will be an empty string andprojects will be an empty array.

Response Body

{
  "projects": [],
  "nextPageToken": ""
}

Page Size

By default, each page will list up to 10 projects. You can change this by setting the pageSize parameter in the request URL. You can increase the limit up to a maximum of 100 projects per page.

Example cURL API Call

curl --request GET \
  --url 'https://api.playfix.io/project/projects?pageSize=2' \
  --header 'Authorization: Bearer <your_access_token>'

Example Python API Call

import requests

r = requests.get(
    "https://api.playfix.io/project/projects",
    params = {
        "pageSize": "2"
        },
    headers = {
        "Authorization": "Bearer <your_access_token"
        }
    )

print(r.text)

This example returns 2 projects per page.

Response Body

{
  "projects": [
    {
      "name": "projects/01g3q945mbbn6dxm4jbwdr82ag",
      "title": "Block Party1",
      "description": "A good block party game",
      "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
      "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    },
    {
      "name":"projects/01gek5939bqgxqq3n1bng2t104", 
      "title":"Dinger", 
      "description":"An interesting home run game", 
      "imageCoverUrl":"https://ipfs-gateway.playfix.io/ipfs/QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe", 
      "imageCoverCid":"QmXTcXRdDaPWnNHHVDroaFo1Nu1WSE1yPmBZv8Ne1MicHe"
    }  
  ],
  "nextPageToken": "projects/01gek5939bqgxqq3n1bng2t104"
}

If the value of pageSize is greater than the number of projects you have, the response will contain all your projects.

PreviousCreate a Project NextRead a Project

Last updated 2 years ago