How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PixieBrix Me API

The me API from PixieBrix — 7 operation(s) for me.

PixieBrix Me API is one of 31 APIs that PixieBrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Me. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 11 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

11 operations 7 paths 7 schemas 2 DELETE6 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Resource Areas
1

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 6 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

me 11
GET
/api/me/
Return the current user's profile, settings, organization and group memberships, and feature flags, or just the feature flags when the request is not authenticated.
retrieveMe → 200
DELETE
/api/me/
Permanently delete the current user's account.
destroyMe → 204
GET
/api/me/partner-principals/
List the current user's control room principals, returning the control room user id and control room URL for each control room the user is linked to.
listControlRoomPrincipals 2 params → 200
GET
/api/me/token/
Return the token for the current user.
retrieveAuthToken → 200
GET
/api/me/settings/webextension/
Return the authenticated user's browser extension UI preferences, such as text selection menu and floating action button settings and their per-site denylists.
retrieveUserExtensionSettings → 200
PATCH
/api/me/settings/webextension/
Update one or more of the authenticated user's browser extension UI preferences, such as text selection menu and floating action button settings and their per-site denylists.
partialUpdateUserExtensionSettings body → 200
GET
/api/me/milestones/
Return the onboarding milestones the current user has reached, each identified by a key with optional metadata.
listMilestones → 200
POST
/api/me/milestones/
Record an onboarding milestone for the current user, replacing the metadata if a milestone with the same key already exists.
createMilestone body → 201
GET
/api/me/deployments/{id}/
View to create, get and delete user deployments.
retrieveUserDeployment 1 param → 200
DELETE
/api/me/deployments/{id}/
View to create, get and delete user deployments.
destroyUserDeployment 1 param → 204
POST
/api/me/deployments/
View to create, get and delete user deployments.
createUserDeployment body → 201

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Deployment (14 properties), Me (14 properties), UserExtensionSettings (5 properties), DeploymentTelemetry (4 properties). Each schema is shown below with its type and property counts.

UserExtensionSettings
object
5 properties 3 required
Me
object
14 properties
Deployment
object
14 properties 3 required
AuthToken
object
1 property
Milestone
object
2 properties 1 required
ControlRoomPrincipal
object
2 properties 1 required
DeploymentTelemetry
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-me-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
PixieBrix Audit API
PixieBrix Bricks API
PixieBrix Campaigns API
PixieBrix Config API
PixieBrix Control Rooms API
PixieBrix Copilot API
PixieBrix Databases API
PixieBrix Deployments API
PixieBrix Events API
PixieBrix Groups API
PixieBrix Health API
Where this information came from

This is an independent, third-party profile of PixieBrix Me API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.