BLNG User API

REST API that manages BLNG users, roles and permissions, workspaces and workspace members, workspace and subscription invitations, organizations, SSO configuration, marketing consent, tooltips, and user subscriptions. Also exposes composite operations that create an organization, subscription and user in a single call. Authenticated with AWS Cognito user tokens, plus a client-credentials machine token for the billing integration.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 47 operations across 33 paths, organized into 8 resource areas, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against the base URL https://users.blng.ai.

47 operations 33 paths 27 schemas 3 DELETE21 GET13 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

1.0.0

Base URL

https://users.blng.ai

Authentication

OAuth 2.0, HTTP Bearer

Resource Areas

Authentication & Security 2

BLNG User API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (cognitoUserAuth) using the implicit flow, exposing 4 scopes. It accepts HTTP bearer tokens (JWT Access Token) (machineBearerToken).

cognitoUserAuth — Cognito authorization code flow for users
machineBearerToken — Cognito authorization code flow for billing token, request token with command like curl -X POST https://auth.app.blng.ai/oauth2/token -H "Content-Type: applica…

Paths & Operations 47

Across 33 paths, the API surfaces 47 operations — 3 DELETE, 21 GET, 13 POST, 10 PUT. They span 8 resource areas: User, User Subscription, Workspace, User Tooltip, Subscription, Invitation, Organization, Composite. Each is listed below with its method, path, parameters, and response codes.

User 4

GET

/users/{userId}

get user

1 param → 200400404500

PUT

/users/{userId}

Update user

1 param body → 200400404500

GET

/users/{userId}/marketing-consent

Get marketing consent state and whether the one-time prompt is due

1 param → 200500

PUT

/users/{userId}/marketing-consent

Record a marketing consent choice, or that the prompt was dismissed

1 param body → 200400403404500

User Subscription 5

GET

/users/{userId}/subscriptions

Get subscriptions associated with user

1 param → 200400404500

POST

/users/{userId}/subscriptionsdeprecated

Associate a subscription with a user

1 param body → 201400404409500

GET

/users/{userId}/subscriptions/{subscriptionId}

get individual subscription by user

2 params → 200400404500

PUT

/users/{userId}/subscriptions/{subscriptionId}deprecated

update user subscriptions by userid and subscriptionId

2 params body → 200400404409500

GET

/subscriptions/{subscriptionId}/users

Get users associated with subscription

1 param → 200400404500

Workspace 19

GET

/users/{userId}/memberships

List workspace memberships for user (multi-tenancy; returns [] when feature off)

1 param → 200500

GET

/users/{userId}/workspaces

List workspaces for user (summaries for switcher; returns [] when feature off)

1 param → 200500

POST

/users/{userId}/workspaces

Create a team, enterprise, or enterprise-team workspace (creator becomes owner)

1 param body → 201400403404500

GET

/users/{userId}/workspaces/{workspaceId}

Get a single workspace (for user) by workspaceId

2 params → 200400404500

PUT

/users/{userId}/workspaces/{workspaceId}

Update editable workspace fields (currently name only)

2 params body → 200400403404500

GET

/users/{userId}/workspaces/{workspaceId}/members

List members for a workspace visible to the requesting user (paginated)

4 params → 200400404500

GET

/users/{userId}/workspaces/{workspaceId}/invitations

List pending workspace invitations (owner/admin)

2 params → 200403404500

POST

/users/{userId}/workspaces/{workspaceId}/invitations

Invite a member by email (team, enterprise, enterprise-team only; owner/admin; SES when configured)

2 params body → 201400403404409500

DELETE

/users/{userId}/workspaces/{workspaceId}/invitations/{invitationId}

Revoke a pending workspace invitation (owner/admin)

3 params → 204400403404409500

POST

/users/{userId}/workspaces/{workspaceId}/invitations/{invitationId}/resend

Resend workspace invite email (team/ent workspaces only; owner/admin; SES)

3 params → 200400403404429500

GET

/users/{userId}/workspace-invitations/inbox

List pending workspace invitations for the signed-in user's email (accept from settings without opening the email link)

1 param → 200403404500

GET

/users/{userId}/workspace-invitations/{invitationId}/email-match

Check whether the signed-in user's email matches a pending workspace invitation; when true, returns workspace display name (public GET does not expose the name)

2 params → 200400403404500

POST

/users/{userId}/workspace-invitations/{invitationId}/accept

Accept a workspace invitation (authenticated; email must match; target must be team/ent workspace)

2 params → 201400403404409503500

GET

/workspace-invitations/{invitationId}

Public invitation metadata for the invite landing page (no auth; workspace name omitted)

1 param → 200400403404500

PUT

/users/{userId}/workspaces/{workspaceId}/members/{memberUserId}

Update a member role (owner/admin; owner-only rules for OWNER role)

3 params body → 200400403404409500

DELETE

/users/{userId}/workspaces/{workspaceId}/members/{memberUserId}

Remove a workspace member (owner/admin; owner-only removal of owners)

3 params → 204400403404409500

GET

/users/{userId}/workspaces/{workspaceId}/integrity

Workspace integrity summary (owner/admin; reporting only)

2 params → 200400403404500

PUT

/users/{userId}/workspaces/{workspaceId}/sso-config

Rotate the workspace's enterprise SAML config (owner/admin; self-service)

2 params body → 200400403404500

PUT

/users/{userId}/active-workspace

Set active workspace (403 when multi-tenancy disabled for stage)

1 param body → 200400403404500

User Tooltip 2

GET

/users/{userId}/tooltips

get tooltips to show to a user

3 params → 200400404500

POST

/users/{userId}/tooltips/resetAll

Resets all viewed tooltips for a user

1 param → 200400404500

Subscription 3

POST

/subscriptionsdeprecated

Create subscription

body → 201400500

GET

/subscriptions/{subscriptionId}

Get subscription

1 param → 200400404500

PUT

/subscriptions/{subscriptionId}

Update subscription

1 param body → 200400404500

Invitation 8

POST

/invitationsdeprecated

create invitation

body → 201400409500

GET

/invitationsdeprecated

get by email

1 param → 200400500

GET

/invitations/{invitationId}deprecated

get invitation

1 param → 200400404500

PUT

/invitations/{invitationId}deprecated

update invitation

1 param body → 200400404409500

DELETE

/invitations/{invitationId}deprecated

delete invitation

1 param → 204400404500

POST

/invitations/{invitationId}/resenddeprecated

resend invitation

1 param → 200400404500

POST

/invitations/{invitationId}/acceptdeprecated

accept invitation

1 param body → 200400404409500

GET

/invitations/subscriptions/{subscriptionId}deprecated

get invitations

1 param → 200400404500

Organization 4

GET

/organizationsdeprecated

get organizations

→ 200500

POST

/organizationsdeprecated

create organization

body → 201400500

GET

/organizations/{organizationId}deprecated

Get organization by ID

1 param → 200400404500

PUT

/organizations/{organizationId}deprecated

Update organization

1 param body → 200400404500

Composite 2

POST

/composite/createOrgAndSubscriptionWithUserdeprecated

Creates an organization, a subscription, and a user, and attaches them in one transaction

body → 201400404409500

POST

/composite/createUserAndSubscriptiondeprecated

Creates a user, a subscription, and attaches them in one transaction. Subscription type is starter.

body → 201400409500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are User (17 properties), Subscription (16 properties), UserWorkspaceSwitcherItem (10 properties), WorkspaceInvitationCreated (9 properties). Each schema is shown below with its type and property counts.

User

object

17 properties

MarketingConsentReceipt

object

Marketing opt-in receipt (GDPR consent provenance). Present only for users who made an explicit choice; optIn records that choice either way. Synced to HubSpot…

4 properties 4 required

MarketingConsentState

object

2 properties 2 required

PutMarketingConsentRequest

WorkspaceMembership

object

Membership row (PK userId, SK workspaceId). Returned by GET /users/{userId}/memberships.

9 properties 5 required

WorkspaceMembersList

object

Paginated list from GET .../workspaces/{workspaceId}/members

2 properties 1 required

UserWorkspaceSwitcherItem

object

Per-membership workspace summary for the UI switcher. Returned by GET /users/{userId}/workspaces. Hydrated fields (name, type, etc.) may be omitted if the work…

10 properties 2 required

UserSubscriptionListItem

UserSubscriptionView

SetActiveWorkspaceRequest

object

1 property 1 required

CreateWorkspaceRequest

object

3 properties 2 required

UpdateWorkspaceRequest

object

1 property 1 required

UpdateMembershipRoleRequest

object

1 property 1 required

CreateWorkspaceInvitationRequest

object

2 properties 2 required

WorkspaceInvitationCreated

object

9 properties 7 required

WorkspacePendingInvitationAdmin

object

8 properties 8 required

WorkspaceInvitationPublic

object

6 properties 6 required

WorkspaceIntegrityReport

object

5 properties 4 required

ErrorResponse

object

1 property

Subscription

object

16 properties

Entitlements

object

2 properties

Invitation

object

7 properties

Organization

object

5 properties

Tooltip

object

5 properties

TooltipRegistration

object

2 properties

UserTooltipFlow

object

6 properties

TooltipResponse

object

1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Workspaces#User#Organization#Subscription#SSO

← Back to B APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=blng-blng-user-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/blng-blng-user-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of BLNG User 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.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

BLNG User API

Metadata

Authentication & Security 2

Paths & Operations 47

Schemas 27

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key