Bricks help center
Bricks appNew features
  • 🏗️ What is Bricks
  • Bricks
    • 🎢Get started
    • 🔦Product tour
    • ✨Features
    • 🤝Integrations
    • 🌎Open API
    • 🚀Changelog
    • 🌈Use cases
      • 🏃‍♂️Sprints & Scrum
      • 📐Lean design & construction
    • 🔭Roadmap
    • 🦄Public projects
    • ❓FAQ
    • 👷Who use it
    • 🔍 Bricks vs Alternatives
      • Bricks vs Trello
      • Bricks vs BIM Sync
    • ⚖️ Legal mentions
    • 📚Press
    • Contact us
  • Community
    • Partners
    • Ambassadors
      • Billel Didri
  • Organization & Accounts
    • 👨‍💻 My account
    • Organizations
      • Create an organization
      • Organization profile
      • Organization members
    • Invite collaborators
    • Permissions & roles
    • Subscription and billing
  • Project
    • Roadmap
    • Workflow Board / Kanban
    • Other boards type
    • 📋 Topics list
    • Table
    • Parameters
    • Teams
    • My topics
    • Checklists
    • Public / Private projects
  • KPI / Analytics
    • 📈 Stats
    • Reports
  • Topics
    • 📃Create a topic
    • Topics tasks
    • Topic properties
    • Topic comment syntax
    • Set a response
    • Move topic between teams
    • Topic templates
    • Export
      • Export to Excel
      • Export to PDF
  • Files
    • 🖼️ Files and images
    • 📐IFC Model viewer
      • Load multiple IFC
  • Integrations
    • Microsoft Teams
    • Integrations settings
    • Slack
    • Google Chat
    • BIM 360
    • Revit plugin
    • Power BI
  • Import
    • Import
    • BCF
    • Trello
  • Notifications
    • ✉️ Notifications & Message
Powered by GitBook
On this page
  • Create Project
  • To create a new project on Bricks App
  • Restore Topics From Template
  • To restore topics from template on Bricks App

Was this helpful?

  1. Bricks

Open API

You want to connect your application with Bricks. Please contact us by email at hello@bricksapp.io 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

{
  "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

{
  "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"
  }
}
PreviousIntegrationsNextChangelog

Last updated 3 years ago

Was this helpful?

🌎