Read a Project

If you already know a project's name, you can fetch the details of that specific project. To get the details for a single project, you will send a GET request to the /project endpoint, with the project name in the URL.

Get the details of a single project

GET https://api.playfix.io/project/<project_name>

Path Parameters

Name	Type	Description
project_name*	String	The project name. This will start with "projects/" followed by a ULID. Example: projects/01g55rpe1a2kxnm1t3f90dy9ke

Headers

Name	Type	Description
Authorization*	String	The access token you get from the authorization process. Example: Bearer <your_access_token>

200: OK Successfully read the project details.

{
  "name": "<project_name>",
  "title": "Block Party1",
  "description": "A good block party game",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
  "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
}

Example cURL API Call

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

Example Python API Call

import requests

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

print(r.text)

Response Body

{
  "name": "<project_name>",
  "title": "Block Party1",
  "description": "A good block party game",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
  "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
}

Response Fields

The response is an object with the project details.

• name - The name that uniquely identifies the project.

• title - The title of the project.

• description - A short description of the project.

• imageCoverUrl - URL to an IPFS gateway that fetches the cover image of the project.

• imageCoverCid - IPFS CID for the cover image of the project.