Skip to main content

Workspaces

The Workspace service manages workspaces, team members, invitations, subscriptions, and billing.

Concepts​

Workspaces​

A workspace is the top-level organizational unit. All resources (brand voices, audiences, generated content) belong to a workspace.

Members & Roles​

Each workspace member has one of three roles:

RoleDescription
OWNERFull control, can manage billing and delete workspace
ADMINCan manage members and most settings
MEMBERCan use features within the workspace

Invitations​

Members are added via email invitations with confirmation codes. Invitations can be accepted, denied, cancelled, or resent.

Endpoints​

Base path: https://app.neuroflash.com/api/workspace-service

Workspaces​

MethodEndpointDescription
POST/v1/workspacesCreate a workspace
GET/v1/workspacesList your workspaces
GET/v1/workspaces/{id}Get a workspace
PUT/v1/workspaces/{id}Update a workspace
DELETE/v1/workspaces/{id}Delete a workspace

Members​

MethodEndpointDescription
GET/v1/workspaces/{id}/workspace-membersList members
GET/v1/workspaces/{id}/workspace-members/{memberId}Get a member
PUT/v1/workspaces/{id}/workspace-members/{memberId}Update member role
DELETE/v1/workspaces/{id}/workspace-members/{memberId}Remove a member

Invitations​

MethodEndpointDescription
POST/v1/workspaces/{id}/invitesCreate an invitation
GET/v1/workspaces/{id}/invitesList invitations
DELETE/v1/workspaces/{id}/invites/{inviteId}Cancel an invitation

Subscriptions & Billing​

MethodEndpointDescription
GET/v1/workspaces/{id}/current-subscriptionGet current subscription
GET/v1/workspaces/{id}/billing-contactGet billing contact
PUT/v1/workspaces/{id}/billing-contactUpdate billing contact
POST/v1/workspaces/{id}/stripe-sessionsGet Stripe billing portal URL