List Brand kits
This endpoint makes an HTTP GET request to retrieve brand kits based on the provided keyword and limit.
Request
Endpoint: https://api.creatopy.com/v1/brandkits
Query Parameters:
keyword (query parameter) - The keyword to search brand kits.
limit (query parameter) - The maximum number of brand kits to retrieve.
cursor: A cursor for pagination.
orderBy: option to order the response results by next fields:
ID
NAME
CREATED_AT
UPDATED_AT
orderDirection: option to order the response by direction: ID
curl --location 'https://api.creatopy.com/v1/brandkits?keyword=api&limit=10' \
--header 'Authorization: Bearer ey...'
Response
The response will be in JSON format with the following structure:
totalCount (number) - The total count of brand kits matching the search criteria.
nodes (array) - An array of brand kit nodes.
pageInfo (object) - Information about the pagination, including whether there is a next page and the end cursor.
{
"response": {
"totalCount": 0,
"nodes": [],
"pageInfo": {
"hasNextPage": true,
"endCursor": ""
}
}
}
Create Brand kits
This endpoint allows you to create a new brand kit.
Request
Endpoint: https://api.creatopy.com/v1/brandkits/create
Body:
name (string, required): The name of the brand kit.
Response
The response is a JSON object with the following schema:
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"brandKit": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"teamId": {
"type": "integer"
},
"typography": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fontId": {
"type": ["integer", "null"]
},
"fontName": {
"type": "string"
},
"fontSize": {
"type": "integer"
},
"fontWeight": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"createdBy": {
"type": "integer"
}
}
}
}
}
}
}
{
"response": {
"brandKit": {
"id": 1594754,
"name": "Brand Kit Name",
"teamId": 1003479,
"typography": [
{
"fontId": null,
"fontName": "Roboto",
"fontSize": 46,
"fontWeight": "700",
"type": "heading"
},
{
"fontId": null,
"fontName": "Roboto",
"fontSize": 24,
"fontWeight": "500",
"type": "subheading"
},
{
"fontId": null,
"fontName": "IBM Plex Sans",
"fontSize": 16,
"fontWeight": "400",
"type": "body"
}
],
"createdBy": 141
}
}
}
Delete Brand kits
This endpoint allows you to delete a brandkit.
Request
Endpoint: https://api.creatopy.com/v1/brandkits
Body:
brandkitId (integer, required): The ID of the brandkit you want to be deleted.
curl --location --request DELETE 'https://api.creatopy.com/v1/brandkits' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhdXRob3JpemF0aW9uIjoiQmVhcmVyIGV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWVhRaU9qRTJPREV4TVRVMU56YzVPRElzSW1Oc2FXVnVkRWxrSWpvaU16QmpaalJsTldRdE1XRmxOQzAwT1RrNExUa3lNV010TVdVMU5qZzJOemd4WW1VeEluMC56WlRDX0ZHZW5FdklRZHhZTlk1cW9OWnlxSEdEOUYtTUtpNm1uV0h6V1NvIiwiYWxnIjoiSFMyNTYifQ.eyJjbGllbnRJZCI6IjZhMzhlYTk3LTEyOWQtNDE3MS04NTljLTU1MzVjOWYzZTRlMSJ9.gWvLWJSqk0bSO78t5xxdYcR08KHAyvQtKCxd0mnlK5U' \
--data '{
"brandkitId": 123
}'
Response
{
"response":
{
"status": "success"
}
}
Update brandkits
This endpoint allows you to update the name of a brandkit.
Request
Endpoint: https://api.creatopy.com/v1/brandkits
Body:
brandkitId (number, required): The brandkit id
name (string): The new name of the brandkit.
Response
The response will be in JSON format with the following structure:
"response": {
"type": "object",
"properties": {
"brandKit": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"teamId": {
"type": "integer"
},
"typography": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fontId": {
"type": ["integer", "null"]
},
"fontName": {
"type": "string"
},
"fontSize": {
"type": "integer"
},
"fontWeight": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"createdBy": {
"type": "integer"
}
}
}
}
}
{
"response": {
"brandKit": {
"id": 1594754,
"name": "The new Brand Kit Name",
"teamId": 1003479,
"typography": [
{
"fontId": null,
"fontName": "Roboto",
"fontSize": 46,
"fontWeight": "700",
"type": "heading"
},
{
"fontId": null,
"fontName": "Roboto",
"fontSize": 24,
"fontWeight": "500",
"type": "subheading"
},
{
"fontId": null,
"fontName": "IBM Plex Sans",
"fontSize": 16,
"fontWeight": "400",
"type": "body"
}
],
"createdBy": 141
}
}
}
