Projects
List projects
This endpoint makes an HTTP GET request to retrieve a list of projects based on the provided keyword, with a specified limit and cursor for pagination
Request
Method: GET
Endpoint:
https://api.creatopy.com/v1beta/projects
Query Parameters:
keyword
: The keyword to search for projects.limit
: The maximum number of projects to be returned.cursor
: A cursor for pagination.
Response
Upon a successful execution, the response will have a status code of 200 and a JSON content type. The response body will contain the following structure:
JSON
The totalCount
indicates the total number of projects found, while the nodes
array contains the project details such as id
, name
, createdBy
, color
, description
, and brandKit
. The pageInfo
object specifies if there are more pages available for pagination, along with the endCursor
for the next page.
Create Project
This endpoint allows you to create a new project.
Request
Method: POST
Endpoint:
https://api.creatopy.com/v1beta/projects
Body:
name
(string, required): The name of the project.brandKitId
(integer, required): The ID of the brand kit associated with the project.
Response
The response of this request can be documented as a JSON schema:
JSON