Gamefound Public API

Introduction

This document provides details on the public API endpoints for retrieving creators and crowdfunding projects from the Gamefound platform. Each endpoint includes descriptions, request parameters, and example responses to help integrate with the API effectively.

Creators API

GET /api/public/creators/getCreator

Gets a creator by its URL name

Description

Retrieves a creator by their unique URL name.

Query Parameters

Name	Type	Required	Description
`urlName`	string	✅ Yes	The URL name of the creator.

Responses

HTTP Status	Type	Description
`200 OK`	`ApiGetCreatorResult`	The creator was found.
`400 BadRequest`	`ApiOperationResult`	The URL name is missing or invalid.

Response Example (200 OK)

{
    "description": "Creator's description",
    "name": "Creator's Name",
    "urlName": "creator-url-name",
    "thumbImageUrl": "https://example.com/image.jpg",
    "creatorPageUrl": "https://example.com/creators/creator-url-name"
}

Response Example (400 BadRequest)

{
    "success": false,
    "error": "The URL name is missing or invalid."
}

Projects API

GET /api/public/projects/getActiveCrowdfundingProjects

Gets a list of active crowdfunding projects

Description

Retrieves a list of active crowdfunding projects, ordered by campaign start date.

Responses

HTTP Status	Type	Description
`200 OK`	`ApiGetCrowdfundingProjectResult[]`	A list of active crowdfunding projects.

Response Example (200 OK)

[
    {
        "backerCount": 1200,
        "updateCount": 5,
        "rewardCount": 10,
        "campaignStartDate": "2025-03-01T00:00:00Z",
        "campaignEndDate": "2025-04-01T00:00:00Z",
        "campaignGoal": 50000,
        "creatorName": "John Doe",
        "creatorUrlName": "john-doe",
        "currencyShortName": "USD",
        "fundsGathered": 75000,
        "projectName": "Amazing Board Game",
        "projectUrlName": "amazing-board-game",
        "shortDescription": "A fantastic game for the whole family.",
        "commentCount": 120,
        "projectHomeUrl": "https://example.com/projects/amazing-board-game",
        "projectImageUrl": "https://example.com/images/project-image.jpg"
    }
]

GET /api/public/projects/getCrowdfundingProject

Gets a crowdfunding project by its URL name

Description

Retrieves a crowdfunding project that is in one of the following phases:

Crowdfunding
Crowdfunding Ended
Late Pledge
Pledge Manager Draft
Pledge Manager
Pledge Manager Complete

Query Parameters

Name	Type	Required	Description
`urlName`	string	✅ Yes	The URL name of the project.

Responses

HTTP Status	Type	Description
`200 OK`	`ApiGetCrowdfundingProjectResult`	The crowdfunding project was found.
`400 BadRequest`	`ApiOperationResult`	The URL name is missing or invalid.

Response Example (200 OK)

{
    "backerCount": 1200,
    "updateCount": 5,
    "rewardCount": 10,
    "campaignStartDate": "2025-03-01T00:00:00Z",
    "campaignEndDate": "2025-04-01T00:00:00Z",
    "campaignGoal": 50000,
    "creatorName": "John Doe",
    "creatorUrlName": "john-doe",
    "currencyShortName": "USD",
    "fundsGathered": 75000,
    "projectName": "Amazing Board Game",
    "projectUrlName": "amazing-board-game",
    "shortDescription": "A fantastic game for the whole family.",
    "commentCount": 120,
    "projectHomeUrl": "https://example.com/projects/amazing-board-game",
    "projectImageUrl": "https://example.com/images/project-image.jpg"
}

Response Example (400 BadRequest)

{
    "success": false,
    "error": "The URL name is missing or invalid."
}

Notes

All public endpoint results are cached for a short duration.