🌎Open API

You want to connect your application with Bricks. Please contact us by email at [e-mail] to get more information.

Create Project

To create a new project on Bricks App

POST https://api.bricksapp.io/nestapi/project/public

Headers

Name	Type	Description
Authorization*	String	apiKey [:yourAPIKey]

Request Body

Name	Type	Description
name*	String	Name of the your new project
organizationId*	String	ID of the organization
description	String
isPrivate	Boolean	If set to true your project could be accessed by people without signing in as an observer. Default is false when not provided
image	String	Image/avatar for the project

200: OK

{
  "data": {
    "id": "string",
    "topic_count": 0,
    "name": "string",
    "private": true,
    "description": "string",
    "organization_id": "string",
    "created_by": "string",
    "created": "Unknown Type: Date",
    "updated": "Unknown Type: Date",
    "photo": "string",
    "users": {
      "id": "string",
      "role": "manager",
      "groups": "string",
      "organization_id": "string"
    },
    "groups": {
      "id": "string",
      "name": "string",
      "is_default": true,
      "board": "string",
      "attachments": "string"
    },
    "attachments": {},
    "label_id": 0,
    "milestone_id": 0,
    "milestones": {},
    "phase_id": 0,
    "phases": {},
    "lot_id": 0,
    "lots": {},
    "priority_id": 0,
    "priorities": {},
    "default_group": "string"
  }
}

Restore Topics From Template

To restore topics from template on Bricks App

POST https://api.bricksapp.io/nestapi/topic/public/restoreTopicsFromTemplate

Headers

Name	Type	Description
Authorization*	String	apiKey [:yourAPIKey]

Request Body

Name	Type	Description
projectId*	String	ID of your project
groupId*	String	ID of your team in the project
templateId*	String	ID of topic template to be used
origins*	String	To set the origin of the template. Available values: "bricks" / "user"
kanbanColumnId*	Number	Kanban Column ID for the topics to be created, the default is -1

200: OK

{
  "data": {
    "id": "string",
    "topic_count": 0,
    "name": "string",
    "private": true,
    "description": "string",
    "organization_id": "string",
    "created_by": "string",
    "created": "Unknown Type: Date",
    "updated": "Unknown Type: Date",
    "photo": "string",
    "users": {
      "id": "string",
      "role": "manager",
      "groups": "string",
      "organization_id": "string"
    },
    "groups": {
      "id": "string",
      "name": "string",
      "is_default": true,
      "board": "string",
      "attachments": "string"
    },
    "attachments": {},
    "label_id": 0,
    "milestone_id": 0,
    "milestones": {},
    "phase_id": 0,
    "phases": {},
    "lot_id": 0,
    "lots": {},
    "priority_id": 0,
    "priorities": {},
    "default_group": "string"
  }
}