Create profile

/api/v2/profilesPOST

Creates a new profile (workspace) in your organization. Requires the admin role. Every plan caps the number of profiles (403 with an upgrade hint when exceeded).

Authorization

apiKey *Bearer <token>

Akarso API key from the dashboard. Token in: header

Request Bodyapplication/jsonrequired

name *string

Display name for the new profile

Min length: 1Max length: 60

Response

200

id *string

Profile ID

name *string

Profile display name

createdAt *string

ISO creation time

default *boolean

True for the organization default profile (the oldest one)

current *boolean

True for the profile this request operates on

400 · Invalid request body, path, or query parameters

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

401 · Missing or invalid API key

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

403

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

limit?number

The plan limit that was hit

used?number

Current usage in this billing period

connected?number

Currently connected accounts

429 · Upstream rate limit reached

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

502 · Upstream platform request failed

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

503 · Upstream service temporarily unavailable or submission outcome unknown

error *string

Human-readable error message

code?string

Machine-readable error code

message?string

Additional error details

Ask AI about this page

Request example

curl -X POST "https://akarso.co/api/v2/profiles" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'