PixieBrix API Documentation

This is the complete API documentation for connecting to the PixieBrix API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet PixieBrix: Build and manage PixieBrix teams, packages, deployments, databases, records, and related admin resources through the PixieBrix Developer API. Keep reading to get started.

Quickstart

Before you run your first PixieBrix request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one PixieBrix connection — create or choose one in Connections. Note its connectionId.

Every PixieBrix action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/pixieBrix/actions/{actionSlug}/run

You need a MindCloud API Key and a PixieBrix connection. Then call an action such as Health Check:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/pixieBrix/actions/health-check/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your PixieBrix account. See PixieBrix API Authentication for the full flow and how to get your connection credentials.

PixieBrix actions

All 24 published actions for this PixieBrix version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Database Record
• GETGet Current User
• GETGet Database
• GETGet Database Asset
• GETGet Database Record
• GETGet Deployment
• GETGet Group
• GETGet Organization
• GETGet Organization Member
• GETGet Package
• GETGet Registry Brick
• GETHealth Check
• GETList Database Assets
• GETList Database Records
• GETList Databases
• GETList Deployment Errors
• GETList Deployments
• GETList Groups
• GETList Organization Memberships
• GETList Organizations
• GETList Package Versions
• GETList Packages
• GETList Registry Bricks
• PUTUpdate Database Record

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp