Organization Management Org CRUD, members, billing, transfer (agent→human), discovery

Base URL: https://api.fast.io/current/ Auth: Bearer {jwt_token}

An organization (org) is a collector of workspaces. It can represent a company, a business unit, a team, or simply a personal collection. Orgs are the billable entity — storage, credits, and member limits are tracked at the org level. Every workspace and share lives under an org.

Profile IDs are 19-digit numeric strings. Most endpoints also accept the org's domain name (e.g., acme) in place of the numeric ID.


Internal vs External Orgs

Agents must call both GET /current/orgs/list/ and GET /current/orgs/list/external/ to discover all orgs they can access.

External orgs are the most common pattern when a human invites an agent to help with a specific project — they add the agent to a workspace but not to the org itself.

If the human later invites the agent to the org itself, it moves from external to internal and gains org-level access.


Org Field Constraints

FieldTypeMinMaxRegex / RulesDefault
domainstring280^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$ Lowercase alphanumeric + hyphens. Must be unique. Must not be reserved.Required
namestring3100Free text display namenull
descriptionstring101000Free textnull
industrystringMust be one of the values from GET /current/orgs/industries/null
perm_member_managestring'Member or above', 'Admin or above', 'Owner only''Member or above'
perm_authorized_domainsstringEmail domain for auto-join (e.g., acme.com)null
billing_emailstring (email)Valid email with reachable domainUser's email
accent_colorstring (JSON)JSON-encoded color objectnull
background_colorstring (JSON)JSON-encoded color objectnull
background_modestringOne of the supported background display modesnull

Member Roles and Permissions

RoleLevelCan manage membersCan manage settingsCan manage billingCan close orgCan transfer ownership
OwnerHighestYesYesYesYesYes
AdminHighYes (if perm_member_manage allows)YesYesNoNo
MemberStandardIf perm_member_manage = 'Member or above'NoNoNoNo
ViewLowestNoNoNoNoNo

The perm_member_manage org setting controls the minimum role required to add, remove, or update members.


Compact Responses (output=)

Every endpoint that returns one or more org objects (details, list, discovery) accepts an optional output query parameter that selects the response shape. A single detail-level token may be combined with modifier tokens; specifying two detail levels (e.g. ?output=terse,standard) returns HTTP 400. When output= is omitted, responses are full and byte-for-byte unchanged.

LevelFields returned on each org (cumulative)
terseid, domain, name, logo
standardterse + description, plan, user_permission, user_status, member, closed, locked (member-only), suspended (member-only), created, updated, parent, capabilities, custom_domain, accent_color, background_mode, background, use_background, background_color, homepage, subscriber (member-only), subscriber_cancel (admin-only), subscriber_trial_until (member-only)
fullstandard + subscriber_trial_credits, billing_email, social links (facebook, instagram, twitter, youtube), encryption_key, perm_* blocks (including perm_auth_domains, perm_member_manage), dmca, owner_defined, platform, storage

Use terse for org switchers and billing-entity pickers — it includes the ID, URL domain, display name, and logo so the org-switcher sidebar can render entries without falling back to initials. Use standard for org list views, most member-facing dashboards, and branding-aware surfaces — it adds plan, description, lifecycle flags (including the locked and suspended lifecycle/billing chips, emitted to members only), the caller's permission and status, timestamps, hierarchy pointer, plan-gated capabilities, custom-domain record, the visual-identity bundle (accent color, background, homepage), and the subscription state fields (subscriber, subscriber_cancel, subscriber_trial_until) that list-view subscription chips render. Use full (or omit the parameter) for the org settings screen, billing portal, auth-domain configuration, and any workflow that reads remaining trial credit, permission blocks, social links, or encryption metadata. Unknown tokens are silently ignored. Add the markdown modifier (e.g. ?output=standard,markdown) to receive the response as GitHub-flavored Markdown (Content-Type: text/markdown; charset=UTF-8) instead of JSON — see the cross-cutting ?output= reference for the full contract.


Organization CRUD

Create Organization

POST /current/org/create/

Auth required. Creates a new organization. The authenticated user becomes the owner.

Request parameters

NameTypeRequiredDescription
domainstringYes2-80 chars, lowercase alphanumeric + hyphens, must be unique and not reserved. Used as the org identifier in URLs.
namestringNo3-100 chars. Display name for the org.
descriptionstringNoOrganization description.
industrystringNoIndustry type from predefined list (see GET /current/orgs/industries/).
accent_colorstring (JSON)NoBrand accent color as JSON.
background_colorstring (JSON)NoBackground color as JSON.
background_modestringNoBackground display mode.
facebook_urlstring (URL)NoFacebook page URL. Must be valid URL.
twitter_urlstring (URL)NoTwitter profile URL. Must be valid URL.
instagram_urlstring (URL)NoInstagram profile URL. Must be valid URL.
youtube_urlstring (URL)NoYouTube channel URL. Must be valid URL.
homepage_urlstring (URL)NoOrganization website URL. Must be valid URL.
perm_member_managestringNoWho can manage members. See Org Field Constraints above.
perm_authorized_domainsstringNoAuthorized email domain for auto-join.
billing_emailstring (email)NoBilling contact email. Defaults to user's email.

Agent accounts are always assigned the agent plan (free: 50 GB storage, 5,000 credits/month, no trial, no expiration). Agents cannot select or change to a human plan.

curl example

curl -X POST "https://api.fast.io/current/org/create/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "domain=acme-corp" \
  -d "name=Acme Corporation" \
  -d "industry=technology"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": null,
      "logo": null,
      "accent_color": null,
      "closed": false,
      "suspended": false
    },
    "has_free_trial": true,
    "requires_payment": false,
    "is_agent": false
  }
}

When user is ineligible for free trial:

{
  "result": "yes",
  "response": {
    "org": { "...": "..." },
    "has_free_trial": false,
    "requires_payment": true,
    "no_trial_reason": "existing_org"
  }
}

Response fields

FieldTypeDescription
orgobjectOrganization resource object
org.idstring19-digit numeric organization ID
org.domainstringURL-safe subdomain
org.namestring/nullDisplay name
org.descriptionstring/nullDescription
org.logostring/nullLogo asset URL
org.accent_colorstring/nullBrand color
org.closedbooleanWhether org is closed
org.suspendedbooleanWhether org is suspended
has_free_trialbooleanWhether the org has a free trial period
requires_paymentbooleanWhether payment is required before activation
is_agentbooleanWhether the creating user is an agent
no_trial_reasonstringReason free trial was denied (only when requires_payment is true)

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid org domain was supplied."Invalid domain format
1605 (Invalid Input)400"The supplied org domain name is restricted."Domain is reserved
1605 (Invalid Input)400"The supplied org domain name is already in use."Domain already taken
1605 (Invalid Input)400"An invalid configuration was supplied..."Metadata validation failed
1605 (Invalid Input)400"Invalid JSON provided for {key}."Malformed JSON in color fields
1663 (Update Failed)400"There was an internal error processing your create request."Org creation failed
1654 (Internal Error)500"There was an internal error processing your create request."Internal error during creation
1654 (Internal Error)500"We were unable to create your organization..."Internal error
1680 (Access Denied)403GEO/risk restriction messageRequest blocked by geo/risk check

Get Org Details

GET /current/org/{org_id}/details/

Auth required. Returns full org details. Fields vary by the requesting user's permission level.

{org_id} accepts a 19-digit numeric ID or the org's domain name.

Access levels

RoleAccessNotes
OwnerFull accessFull access to all organization settings and security configuration
AdminExtended accessIncludes billing info, permissions, subscriber status, credit balance
MemberStandard accessBasic org info, plan, subscriber status (boolean only — no credit balance)
ViewLimited accessPublic fields only

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": "Leading provider of innovation",
      "logo": "https://assets.fast.io/org/logo.png",
      "accent_color": "#0066CC",
      "closed": false,
      "locked": false,
      "suspended": false,
      "created": "2024-01-15 10:30:00",
      "updated": "2024-06-20 14:45:00"
    }
  }
}

Response fields

FieldTypeDescription
org.idstring19-digit numeric organization ID
org.domainstringURL-safe subdomain
org.namestring/nullDisplay name
org.descriptionstring/nullDescription
org.logostring/nullLogo asset URL
org.accent_colorstring/nullBrand color
org.closedbooleanWhether org is closed
org.lockedbooleanWhether org is locked
org.suspendedbooleanWhether org is suspended
org.createdstringCreation timestamp
org.updatedstringLast update timestamp
org.planstringBilling plan identifier (e.g., "free", "agent", "pro"). Member+ only.
org.subscriberbooleanWhether the org has an active subscription (includes credit availability for free-tier orgs). Member+ only.
org.subscriber_trial_untilinteger/nullUnix timestamp when the trial period ends. null for paid plans. Member+ only.
org.subscriber_trial_creditsinteger/nullCredits remaining in the current billing period. null for unlimited (paid) plans. Admin+ only.

Error responses

Error CodeHTTP StatusMessageCause
1680 (Access Denied)403"You have not been granted access to this Org."Insufficient permission
1688 (Subscription Required)402"The organization does not have an active subscription."Org has no active subscription or free-tier credits exhausted
1696 (Credit Limit Exceeded)402"You have exceeded your credit limit."Free-tier credit limit exceeded

Get Public Org Details

GET /current/org/{org_id}/public/details/

No authentication required. Returns limited public info about an org (name, domain, assets). IP-rate-limited.

{org_id} accepts a 19-digit numeric ID or the org's domain name.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/public/details/"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "acme-corp",
      "name": "Acme Corporation",
      "description": "Leading provider of innovation",
      "logo": "https://assets.fast.io/org/logo.png",
      "accent_color": "#0066CC"
    }
  }
}

Response fields

FieldTypeDescription
org.idstring19-digit numeric organization ID
org.domainstringURL-safe subdomain
org.namestring/nullDisplay name
org.descriptionstring/nullDescription
org.logostring/nullLogo asset URL
org.accent_colorstring/nullBrand color

Update Organization

POST /current/org/{org_id}/update/

Auth required. Admin or above. Updates org details. Only provided fields are modified.

Access levels

RoleAccess
OwnerFull access
AdminFull access
MemberDenied

Request parameters (all optional)

NameTypeDescription
domainstringNew URL-safe subdomain (2-80 chars, lowercase alphanumeric + hyphens).
namestringDisplay name (3-100 chars). Send "null" to clear.
descriptionstringDescription. Send "null" or "" to clear.
industrystringIndustry type from predefined list.
accent_colorstring (JSON)Brand accent color as JSON. Send "null" to clear.
background_colorstring (JSON)Background color as JSON. Send "null" to clear.
background_modestringBackground display mode.
use_backgroundstringEnable/disable background ("true"/"false").
facebook_urlstring (URL)Facebook URL.
twitter_urlstring (URL)Twitter URL.
instagram_urlstring (URL)Instagram URL.
youtube_urlstring (URL)YouTube URL.
homepage_urlstring (URL)Organization website URL.
perm_member_managestringMember management permission level.
perm_authorized_domainsstringAuthorized email domain for auto-join.
billing_emailstring (email)Billing contact email. Domain must be reachable.
owner_definedstring (JSON)Custom owner-defined properties. Send "null" or "" to clear.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/update/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "name=Acme Corp Updated" \
  -d "description=Updated description" \
  -d "industry=technology"

Response (200 OK)

{
  "result": "yes"
}

If no actual changes are detected, returns success immediately.

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid org domain was supplied."Invalid domain format
1605 (Invalid Input)400"The supplied org domain name is restricted."Domain is reserved
1605 (Invalid Input)400"The supplied org domain name is already in use."Domain taken by another org
1605 (Invalid Input)400"An invalid configuration was supplied..."Metadata validation failed
1605 (Invalid Input)400"Invalid JSON provided for {key}."Malformed JSON
1605 (Invalid Input)400"The email domain is invalid or cannot receive email."Bad billing email domain
1663 (Update Failed)400"There was an internal error processing your update request."Internal error

Close Organization

POST /current/org/{org_id}/close/

Auth required. Owner only. Soft-deletes the organization. Active subscriptions are automatically cancelled.

Request parameters

NameTypeRequiredDescription
confirmstringYesMust match the org domain name or org numeric ID as confirmation.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/close/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "confirm=acme-corp"

Response (202 Accepted)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"The confirm field provided does not match."Confirmation does not match domain or ID
1663 (Update Failed)400"There was an internal error processing your request."Failed to close org

Storage deletion is deferred to the deletion system after a retention period.


Organization Assets

List Available Asset Types

GET /current/org/assets/

Auth required. Returns available org asset metadata types (e.g., logo, background images).

curl example

curl -X GET "https://api.fast.io/current/org/assets/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "assets": [
      {
        "name": "logo",
        "mime_types": ["image/png", "image/jpeg"],
        "max_size": 5242880
      }
    ]
  }
}

List Org Assets

GET /current/org/{org_id}/assets/

Auth required. Any member with at least View permission. Returns assets currently set on the org.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/assets/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "assets": {
      "logo": {
        "url": "https://assets.fast.io/org/logo.png",
        "mime_type": "image/png",
        "size": 45678
      }
    }
  }
}

Upload Org Asset

POST /current/org/{org_id}/assets/{asset_name}/

Auth required. Admin or above. Upload as multipart/form-data.

Request parameters

NameTypeRequiredDescription
filefile (multipart)YesThe asset file to upload.
metadatastring (JSON array)NoAdditional metadata for the asset.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/assets/logo/" \
  -H "Authorization: Bearer {jwt_token}" \
  -F "file=@logo.png"

Error responses

Error CodeHTTP StatusMessageCause
1604 (File Missing)400"Asset upload missing"No file in the request
1605 (Invalid Input)400"metadata invalid"Metadata is not a valid array

Delete Org Asset

DELETE /current/org/{org_id}/assets/{asset_name}/

Auth required. Admin or above.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/assets/logo/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Read Org Asset (Raw)

GET /current/org/{org_id}/assets/{asset_name}/read/

No authentication required. Returns the raw binary content of an org asset with appropriate Content-Type header. Useful for displaying logos and images directly.

HEAD requests return headers only.


Organization Members

Add or Invite a Member

POST /current/org/{org_id}/members/{email_or_user_id}/

Auth required. Permission governed by org's perm_member_manage setting.

The target is specified as a path parameter:

Request parameters (adding existing user by ID)

NameTypeRequiredDescription
permissionsstringYesPermission level: "member", "admin". Cannot add as "owner".
expiresstring (datetime)NoMembership expiration date.
notifystringNoNotification preference.
force_notificationbooleanNoForce send a notification email.

Request parameters (inviting by email)

NameTypeRequiredDescription
permissionsstringYesPermission level for the invitation: "member", "admin".
messagestringNoCustom invitation message.
expiresstring (datetime)NoInvitation expiration.

curl example (add existing user)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/9876543210987654321/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=member"

curl example (invite by email)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/jane@example.com/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=member" \
  -d "message=Welcome to the team!"

Response (200 OK) — direct add

{
  "result": "yes"
}

Response (200 OK) — invitation created

{
  "result": "yes",
  "response": {
    "invitation": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "invitee_email": "jane@example.com",
      "entity_type": "org",
      "state": "pending",
      "created": "2024-01-15 10:30:00"
    }
  }
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"Invalid permission specified."Invalid permission value
1680 (Cannot Add As Owner)403"Adding a member as an owner is not allowed"Tried to add as owner (use transfer_ownership)
1656 (Limit Exceeded)429Limit messageMember limit exceeded

Remove a Member

DELETE /current/org/{org_id}/members/{user_id}/

Auth required. Permission governed by org's perm_member_manage setting.

The target user ID (19-digit numeric) is a path parameter.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/members/9876543210987654321/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

List Org Members

GET /current/org/{org_id}/members/list/

Auth required. Any org member. Paginated.

Query parameters

NameTypeDefaultDescription
limitinteger1001-500, number of items to return
offsetinteger0Number of items to skip

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/members/list/?limit=50&offset=0" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "users": [
      {
        "id": "1234567890123456789",
        "account_type": "human",
        "email_address": "owner@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "permissions": "owner"
      },
      {
        "id": "1234567890123456780",
        "account_type": "agent",
        "email_address": "bot@example.com",
        "first_name": "Service",
        "last_name": "Bot",
        "permissions": "admin"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "has_more": false
    }
  }
}

Response fields

FieldTypeDescription
usersarrayArray of member objects
users[].idstring19-digit numeric user ID
users[].account_typestring"human" or "agent"
users[].email_addressstringUser's email
users[].first_namestringFirst name
users[].last_namestringLast name
users[].permissionsstringRole: "owner", "admin", "member"
pagination.totalintegerTotal number of members
pagination.limitintegerRequested page size
pagination.offsetintegerCurrent offset
pagination.has_morebooleanWhether more results exist

Leave Organization (Self)

DELETE /current/org/{org_id}/member/

Auth required. Removes the authenticated user from the org. Owners cannot leave — they must transfer ownership or close the org first.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/member/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"You cannot leave an org you are the owner of..."User is the org owner
1605 (Invalid Input)400"You cannot leave an org you are not a member of."User is not a member

Get Member Details

GET /current/org/{org_id}/member/{user_id}/details/

Auth required. Any org member.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "member": {
      "id": "9876543210987654321",
      "account_type": "human",
      "email_address": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "permissions": "admin",
      "invite": "accepted",
      "notify": "Email me",
      "expires": null
    }
  }
}

Response fields

FieldTypeDescription
member.idstring19-digit numeric user ID
member.account_typestring"human" or "agent"
member.email_addressstringUser's email
member.first_namestringFirst name
member.last_namestringLast name
member.permissionsstringRole: "owner", "admin", "member"
member.invitestringInvitation status
member.notifystringNotification preference
member.expiresstring/nullMembership expiration (YYYY-MM-DD HH:MM:SS) or null for no expiry

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"The membership you specified does not exist."User is not a member

Update Member Permissions

POST /current/org/{org_id}/member/{user_id}/update/

Auth required. Permission governed by org's perm_member_manage setting.

Request parameters (all optional)

NameTypeDescription
permissionsstringNew permission level ("member", "admin")
expiresstring (datetime)Membership expiration date
notifystringNotification preference

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/update/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=admin"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"The membership you specified does not exist."User is not a member

Transfer Org Ownership

POST /current/org/{org_id}/member/{user_id}/transfer_ownership/

Auth required. Owner only. Transfers ownership of the org to the specified member. The current owner is demoted to admin.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/member/9876543210987654321/transfer_ownership/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"You cannot transfer ownership to yourself."Target is the current user
1605 (Invalid Input)400"The membership you specified does not exist."User is not an org member
1605 (Invalid Input)400"Member is already an owner."Target is already the owner
1663 (Update Failed)400"Failed to update owner of the org."Internal error

Join Organization

POST /current/org/{org_id}/members/join/

Auth required. Join an org via invite or domain-based auto-join.

Join methods

  1. Via invitation: Append the invitation key to the URL path: .../join/{invitation_key}/ optionally followed by accept or decline. Default is accept.
  2. Via authorized domain: The org must have perm_authorized_domains set and the user's email domain must match. User is added as a Member.

curl example (invitation)

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/join/abc123def456/accept/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1680 (Access Denied)403"This org does not allow you to join automatically..."Domain auto-join not enabled
1680 (Access Denied)403"You are not allowed to join this org automatically..."User's email domain does not match
1656 (Limit Exceeded)429Limit messageMember limit exceeded

List Org Invitations

GET /current/org/{org_id}/members/invitations/list/

Auth required. Any org member. An optional state filter can be appended: .../list/pending/.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/members/invitations/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "invitations": [
      {
        "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
        "inviter": "John Doe",
        "invitee_email": "jane@example.com",
        "entity_type": "org",
        "state": "pending",
        "created": "2024-01-15 10:30:00",
        "expires": "2024-02-15 10:30:00"
      }
    ]
  }
}

Response fields

FieldTypeDescription
invitationsarrayArray of invitation objects
invitations[].idstringInvitation identifier
invitations[].inviterstringName of the user who sent the invitation
invitations[].invitee_emailstringEmail address of the invitee
invitations[].entity_typestringAlways "org" for org invitations
invitations[].statestringInvitation state: "pending", "accepted", "declined"
invitations[].createdstringCreation timestamp
invitations[].expiresstring/nullExpiration timestamp

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid invitation state was supplied."Invalid state filter

Update an Invitation

POST /current/org/{org_id}/members/invitation/{invitation_id}/

Auth required. Permission governed by org's perm_member_manage setting.

{invitation_id} can be the invitation ID or the invitee email address.

Request parameters (all optional)

NameTypeDescription
statestringNew invitation state
permissionsstringUpdated permission level
expiresstring (datetime)Updated expiration date

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/members/invitation/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "permissions=admin"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid invitation ID or email was supplied."Invalid identifier
1605 (Invalid Input)400"Invitation not found."Invitation does not exist
1605 (Invalid Input)400"Invitation is not for an Org"Wrong entity type
1605 (Invalid Input)400"An invalid state was supplied."Invalid state value
1679 (Update Failed)400"Failed to update invitation."Internal error

Delete an Invitation

DELETE /current/org/{org_id}/members/invitation/{invitation_id}/

Auth required. Permission governed by org's perm_member_manage setting.

{invitation_id} can be the invitation ID or the invitee email address.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/members/invitation/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1666 (Delete Failed)400"Failed to delete invitation."Deletion failed

Organization Transfer (Agent to Human)

Agents build orgs, then transfer ownership to humans. The human gets the org plus all workspaces; the agent stays as admin. Only agent accounts can create/list/delete tokens; only human accounts can claim.

The claim URL for humans: https://go.fast.io/claim?token={token}

Create Transfer Token

POST /current/org/{org_id}/transfer/token/create/

Auth required. Agent owner only. Org must be on the agent plan.

Creates a transfer token: 64-character string, valid 72 hours. Max 5 active tokens per org.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/transfer/token/create/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
      "org_id": 1234567890123456789,
      "state": "pending",
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    }
  }
}

Response fields

FieldTypeDescription
transfer_token.idstringOpaque identifier of the transfer token
transfer_token.tokenstring64-character token string to share with the human user
transfer_token.org_idintegerOrganization being transferred
transfer_token.statestringToken state: "pending"
transfer_token.expiresstringExpiry timestamp, 72 hours from creation (YYYY-MM-DD HH:MM:SS)
transfer_token.createdstringCreation timestamp (YYYY-MM-DD HH:MM:SS)

Error responses

Error CodeHTTP StatusMessageCause
1650 (Authentication Invalid)401"Authentication required"Missing or invalid token
1680 (Access Denied)403"Only agent accounts can create org transfer tokens."Non-agent user attempted creation
1680 (Access Denied)403"Transfer tokens can only be created for organizations on the agent plan."Org not on agent plan
1658 (Not Acceptable)406"Maximum of 5 active transfer tokens per organization."Token limit reached

List Transfer Tokens

GET /current/org/{org_id}/transfer/token/list/

Auth required. Agent owner only. Returns all active (pending) transfer tokens for the org.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/transfer/token/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "results": 1,
    "transfer_tokens": [
      {
        "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
        "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
        "org_id": 1234567890123456789,
        "state": "pending",
        "expires": "2026-02-04T12:00:00+00:00",
        "created": "2026-02-01T12:00:00+00:00"
      }
    ]
  }
}

Error responses

Error CodeHTTP StatusMessageCause
1650 (Authentication Invalid)401"Authentication required"Missing or invalid token
1680 (Access Denied)403"Only agent accounts can list org transfer tokens."Non-agent user

Delete Transfer Token

DELETE /current/org/{org_id}/transfer/token/{token_id}/

Auth required. Agent owner only. Soft-deletes a pending transfer token.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/transfer/token/eA1B2C3D4E5F6G7H8J9K0L1M2N3O4/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "token": "a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2",
      "org_id": 1234567890123456789,
      "state": "deleted",
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    }
  }
}

Error responses

Error CodeHTTP StatusMessageCause
1650 (Authentication Invalid)401"Authentication required"Missing or invalid token
1680 (Access Denied)403"Only agent accounts can delete org transfer tokens."Non-agent user
1680 (Access Denied)403"Transfer token does not belong to this organization."Token/org mismatch
1683 (Resource Missing)404"Transfer token not found."Invalid token ID
1658 (Not Acceptable)406"Token cannot be deleted."Token already claimed/expired/deleted

Public Token Details (Preview Before Claiming)

GET /current/org/transfer/claim/public/details/

No auth required. IP-rate-limited. Preview transfer token details before claiming.

Query parameters

NameTypeRequiredDescription
tokenstringYes64-character transfer token string

curl example

curl -X GET "https://api.fast.io/current/org/transfer/claim/public/details/?token=a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "transfer_token": {
      "id": "eA1B2C3D4E5F6G7H8J9K0L1M2N3O4",
      "state": "pending",
      "is_claimable": true,
      "expires": "2026-02-04T12:00:00+00:00",
      "created": "2026-02-01T12:00:00+00:00"
    },
    "org": {
      "id": "1234567890123456789",
      "domain": "my-agent-org",
      "name": "My Agent Org",
      "description": "An org built by an AI agent",
      "logo": null,
      "accent_color": null,
      "closed": false,
      "suspended": false
    },
    "created_by": {
      "id": "9876543210987654321",
      "account_type": "agent",
      "email_address": "agent@example.com",
      "first_name": "Agent",
      "last_name": "Smith"
    }
  }
}

Response fields

FieldTypeDescription
transfer_token.idstringToken identifier
transfer_token.statestring"pending", "claimed", "expired", or "deleted"
transfer_token.is_claimablebooleantrue if the token is pending and not expired
transfer_token.expiresstringExpiry timestamp (YYYY-MM-DD HH:MM:SS)
transfer_token.createdstringCreation timestamp (YYYY-MM-DD HH:MM:SS)
orgobject/nullOrganization info. null if the org has been deleted.
created_byobject/nullAgent creator profile. null if the creator no longer exists.

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"A transfer token is required."Missing token query parameter
1605 (Invalid Input)400"Invalid transfer token format."Token string is not exactly 64 characters
1683 (Resource Missing)404"Transfer token not found or invalid."No token matches

Claim Organization

POST /current/org/transfer/claim/

Auth required. Human users only.

Request parameters

NameTypeRequiredDescription
tokenstringYes64-character transfer token string

curl example

curl -X POST "https://api.fast.io/current/org/transfer/claim/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "token=a1b2c3d4e5f6g7h8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "org": {
      "id": "1234567890123456789",
      "domain": "my-agent-org",
      "plan": "free"
    },
    "previous_owner": {
      "id": "9876543210987654321",
      "account_type": "agent"
    },
    "workspaces_transferred": 3
  }
}

Response fields

FieldTypeDescription
org.idstringOrganization profile ID
org.domainstringOrganization domain
org.planstringNew billing plan (typically "free")
previous_owner.idstringPrevious agent owner's user ID
previous_owner.account_typestringAlways "agent"
workspaces_transferredintegerNumber of workspaces whose membership was transferred

What happens during claim

  1. Organization ownership transfers to the human user
  2. Previous agent owner becomes an admin member of the org
  3. Billing plan changes from agent to free (credit-based, no trial period)
  4. All workspaces: human becomes owner, agent becomes admin
  5. Transfer token marked as "claimed"
  6. Free trial period starts from the transfer date

Error responses

Error CodeHTTP StatusMessageCause
1650 (Authentication Invalid)401"Authentication required"Missing or invalid token
1680 (Access Denied)403"Agent accounts cannot claim organizations."Agent user attempted claim
1683 (Resource Missing)404"Transfer token not found or invalid."Invalid token string
1658 (Not Acceptable)406"This transfer token has expired."Token past expiry
1658 (Not Acceptable)406"This transfer token has already been used."Token not pending
1658 (Not Acceptable)406"This organization is no longer eligible for transfer."Org not on agent plan

Organization Discovery

List Internal Orgs

GET /current/orgs/list/

Auth required. Lists orgs where the user is a direct member (member: true).

Non-admin/non-owner members only see orgs with active subscriptions; admins and owners always see their orgs.

curl example

curl -X GET "https://api.fast.io/current/orgs/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456789",
        "domain": "acme-corp",
        "name": "Acme Corporation",
        "description": "Leading provider of innovation",
        "logo": "https://assets.fast.io/org/logo.png",
        "accent_color": "#0066CC",
        "closed": false,
        "suspended": false,
        "subscriber": true,
        "user_status": "joined",
        "member": true
      }
    ]
  }
}

Response fields

FieldTypeDescription
orgsarrayArray of organization objects
orgs[].idstring19-digit numeric organization ID
orgs[].domainstringURL-safe subdomain
orgs[].namestring/nullDisplay name
orgs[].descriptionstring/nullDescription
orgs[].logostring/nullLogo asset URL
orgs[].accent_colorstring/nullBrand color
orgs[].closedbooleanWhether org is closed
orgs[].suspendedbooleanWhether org is suspended
orgs[].subscriberbooleanWhether org has an active subscription
orgs[].user_statusstring"joined" or "available"
orgs[].memberbooleanAlways true for this endpoint

Subscription filtering

User RoleBehavior
OwnerAlways sees the org
AdminAlways sees the org
MemberOnly sees the org if it has an active subscription

List External Orgs

GET /current/orgs/list/external/

Auth required. Lists orgs where the user has access only through workspace membership (member: false).

curl example

curl -X GET "https://api.fast.io/current/orgs/list/external/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456780",
        "domain": "partner-corp",
        "name": "Partner Corporation",
        "description": "External partner organization",
        "logo": null,
        "accent_color": "#FF6600",
        "closed": false,
        "suspended": false,
        "subscriber": true,
        "user_status": "available",
        "member": false
      }
    ]
  }
}

Response fields

FieldTypeDescription
orgsarrayArray of external organization objects
orgs[].user_statusstringAlways "available" for external orgs
orgs[].memberbooleanAlways false for this endpoint

List All Orgs

GET /current/orgs/all/

Auth required. Lists all accessible orgs (joined + invited).

curl example

curl -X GET "https://api.fast.io/current/orgs/all/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456789",
        "domain": "acme-corp",
        "name": "Acme Corporation",
        "description": "Leading provider of innovation",
        "logo": "https://assets.fast.io/org/logo.png",
        "accent_color": "#0066CC",
        "closed": false,
        "suspended": false,
        "user_status": "joined"
      }
    ]
  }
}

Response fields

FieldTypeDescription
orgs[].user_statusstring"joined" (already a member) or "available" (pending invitation)

List Available Orgs

GET /current/orgs/available/

Auth required. Lists orgs available to join (not yet joined). Excludes orgs the user is already a member of.

curl example

curl -X GET "https://api.fast.io/current/orgs/available/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "orgs": [
      {
        "id": "1234567890123456782",
        "domain": "new-company",
        "name": "New Company",
        "description": "An org you can join",
        "logo": null,
        "accent_color": "#FF6600",
        "closed": false,
        "suspended": false
      }
    ]
  }
}

Check Domain Availability

GET /current/orgs/check/domain/{domain_name}

Auth required. Checks if an org domain name is available for use.

Path parameters

NameTypeRequiredDescription
{domain_name}stringYesThe domain name to check for availability.

curl example

curl -X GET "https://api.fast.io/current/orgs/check/domain/acme-corp" \
  -H "Authorization: Bearer {jwt_token}"

Response (202 Accepted) — domain available

{
  "result": "yes"
}

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid name was supplied."Domain format is invalid
1658 (Not Acceptable)406"The supplied name is restricted."Domain is reserved
1658 (Not Acceptable)406"The supplied name is already in use."Domain is taken

List Industries

GET /current/orgs/industries/

Auth required. Returns available industry types for org profiles.

curl example

curl -X GET "https://api.fast.io/current/orgs/industries/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "technology": {
      "title": "Technology",
      "description": "Software, hardware, and IT services"
    },
    "healthcare": {
      "title": "Healthcare",
      "description": "Medical, pharmaceutical, and health services"
    },
    "finance": {
      "title": "Finance",
      "description": "Banking, investment, and financial services"
    },
    "education": {
      "title": "Education",
      "description": "Schools, universities, and training providers"
    }
  }
}

Response fields

FieldTypeDescription
{key}stringMachine-readable industry identifier (use this value in create/update requests)
{key}.titlestringHuman-readable display name
{key}.descriptionstringBrief description of the industry category

Billing

Create or Update Subscription

POST /current/org/{org_id}/billing/

Auth required. Admin or above. Creates or updates the org's billing subscription.

Request parameters

NameTypeRequiredDescription
billing_planstringNoTarget plan ID (must be a valid paid plan, e.g., "pro_monthly", "business_monthly").

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/billing/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "billing_plan=pro_monthly"

Response (201 Created) — new subscription

{
  "result": "yes",
  "response": {
    "subscription": { "...": "..." },
    "customer": { "...": "..." },
    "setup_intent": {
      "id": "{setup_id}",
      "client_secret": "{setup_id}_secret",
      "status": "requires_payment_method"
    },
    "is_active": false,
    "is_trial_eligible": true,
    "public_key": "{public_key}"
  }
}

Response (202 Accepted) — subscription updated.

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"An invalid plan was supplied."Plan ID not recognized
1605 (Invalid Input)400"Cannot create subscription for a free plan."Tried to subscribe to free plan
1658 (Not Acceptable)406"An error occurred updating your subscription..."Subscription update failed
1658 (Not Acceptable)406"An error occurred creating the payment intent..."Intent creation failed

Cancel Subscription

DELETE /current/org/{org_id}/billing/

Auth required. Owner only. Cancels the org's subscription.

curl example

curl -X DELETE "https://api.fast.io/current/org/1234567890123456789/billing/" \
  -H "Authorization: Bearer {jwt_token}"

Response (202 Accepted)

{
  "result": "yes",
  "response": {
    "status": "cancelled",
    "message": "Subscription has been successfully cancelled",
    "closed": false
  }
}

If already cancelled:

{
  "result": "yes",
  "response": {
    "status": "already_cancelled",
    "message": "Subscription is already cancelled"
  }
}

Response fields

FieldTypeDescription
statusstring"cancelled" or "already_cancelled"
messagestringHuman-readable status message
closedbooleanWhether the account was also closed (plan-dependent)

Error responses

Error CodeHTTP StatusMessageCause
1683 (Resource Missing)404"No subscription was found to cancel."Org is not a subscriber
1654 (Internal Error)500"Your subscription failed to be canceled..."Cancellation failed

Get Billing Details

GET /current/org/{org_id}/billing/details/

Auth required. Admin or above. Returns subscription/billing details.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/details/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "subscription": { "...": "..." },
    "customer": { "...": "..." },
    "setup_intent": { "...": "..." },
    "payment_intent": { "...": "..." },
    "is_active": true,
    "is_trial_eligible": false,
    "is_cancelled": false,
    "current_plan": "pro_monthly",
    "previous_plan": null,
    "public_key": "{public_key}"
  }
}

Response fields

FieldTypeDescription
subscriptionobjectPayment provider subscription details
customerobjectPayment provider customer details
setup_intentobject/nullActive setup intent if exists
payment_intentobject/nullActive payment intent if exists
is_activebooleanWhether subscription is currently active
is_trial_eligiblebooleanWhether org is eligible for a trial
is_cancelledbooleanWhether subscription is cancelled
current_planstring/nullCurrent plan ID
previous_planstring/nullPrevious plan ID (if changed)
public_keystringPayment provider publishable key

Get Credit Usage

GET /current/org/{org_id}/billing/usage/limits/credits/

Auth required. Admin or above. Returns credit consumption and limits.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/limits/credits/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": true,
  "credit_limits_enabled": true,
  "free_org_mode": true,
  "org_id": "1234567890123456789",
  "plan": "free",
  "over_limit": false,
  "usage": {
    "credits_used": 1200,
    "credit_limit": 10000,
    "credits_remaining": 8800,
    "usage_percentage": 12.0
  },
  "period": {
    "start": "2025-01-15T10:00:00+00:00",
    "end": "2025-02-14T10:00:00+00:00",
    "days_total": 30,
    "days_elapsed": 10,
    "days_remaining": 20
  },
  "renewal": {
    "interval_days": 30,
    "next_renewal": "2025-02-14T10:00:00+00:00"
  },
  "trial": null
}

Response fields

FieldTypeDescription
credit_limits_enabledbooleanWhether the plan enforces credit limits
free_org_modebooleantrue for free orgs (reductive model)
over_limitbooleanWhether the org has exceeded its credit limit
usage.credits_usedintegerCredits consumed in the current period
usage.credit_limitintegerTotal credits available per period
usage.credits_remainingintegerCredits remaining in the current period
usage.usage_percentagenumberPercentage of credits used
period.startstringStart of the current billing period (YYYY-MM-DD HH:MM:SS)
period.endstringEnd of the current billing period (YYYY-MM-DD HH:MM:SS)
period.days_totalintegerTotal days in the period
period.days_elapsedintegerDays elapsed since period start
period.days_remainingintegerDays remaining until renewal
renewal.interval_daysintegerDays between credit renewals
renewal.next_renewalstring/nullNext credit renewal timestamp (YYYY-MM-DD HH:MM:SS), or null
run_rateobject/nullUsage rate projections (shown after 25% of period or credits used)
trialobject/nullTrial info if applicable

Credit costs: storage (100/GB), bandwidth (212/GB), AI tokens (1/100 tokens), document ingestion (10/page), video ingestion (5/sec), image ingestion (5/image), file conversions (25/each).


List Billable Members

GET /current/org/{org_id}/billing/usage/members/list/

Auth required. Admin or above. Paginated.

Query parameters

NameTypeDefaultDescription
limitinteger1001-500
offsetinteger0Items to skip

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/members/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "billable_members": [
      {
        "id": "1234567890123456789",
        "account_type": "human",
        "email_address": "user@example.com",
        "parents": {
          "9876543210987654321": {
            "permission": "member",
            "date_joined": "2024-01-15 10:30:00"
          }
        }
      }
    ]
  }
}

Response fields

FieldTypeDescription
billable_membersarrayArray of billable member objects
billable_members[].idstring19-digit user ID
billable_members[].account_typestring"human" or "agent"
billable_members[].email_addressstringUser's email
billable_members[].parentsobjectMap of workspace IDs to membership details

Get Usage Meters

GET /current/org/{org_id}/billing/usage/meters/list/

Auth required. Admin or above. Returns detailed usage breakdown by meter.

Query parameters

NameTypeRequiredDefaultDescription
meterstringYesMeter type (e.g., "storage_bytes", "bandwidth_bytes", "ai_tokens")
start_timestring (datetime)No30 days agoStart of time range
end_timestring (datetime)NoNowEnd of time range
workspace_idstringNoFilter by workspace (19-digit ID)
share_idstringNoFilter by share (19-digit ID)

Only one of workspace_id or share_id can be specified at a time.

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/usage/meters/list/?meter=storage_bytes&start_time=2024-01-01+00:00:00&end_time=2024-01-31+23:59:59" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "usage": {
      "meter": "storage_bytes",
      "total": 1073741824,
      "cost": 0.50,
      "credits": 500,
      "start_time": "2024-01-01 00:00:00 UTC",
      "end_time": "2024-01-31 23:59:59 UTC",
      "interval_hours": 24,
      "workspace_id": null,
      "share_id": null,
      "data_points": [
        {
          "start_time": "2024-01-01 00:00:00 UTC",
          "end_time": "2024-01-02 00:00:00 UTC",
          "value": 536870912,
          "cost": 0.25,
          "credits": 250
        }
      ]
    }
  }
}

Response fields

FieldTypeDescription
usage.meterstringThe meter type queried
usage.totalnumberTotal usage value for the period
usage.costnumberTotal cost in USD
usage.creditsnumber/nullTotal credits consumed (null for direct-billed meters)
usage.start_timestringStart of the queried range
usage.end_timestringEnd of the queried range
usage.interval_hoursintegerHours per data point (auto-calculated, max 30 points)
usage.data_pointsarrayTime-series data with value, cost, and credits per interval

Error responses

Error CodeHTTP StatusMessageCause
1605 (Invalid Input)400"Must be one of the valid meter types"Invalid meter type
1605 (Invalid Input)400"Only one of workspace_id or share_id can be specified."Both filters provided
1605 (Invalid Input)400"Start time must be before end time."Invalid time range
1605 (Invalid Input)400"Time range must be at least 1 day."Range too short
1654 (Internal Error)500"Failed to retrieve usage data."Internal error

List Available Plans

GET /current/org/billing/plan/list/

Auth required. Returns available billing plans. Filtered by account type.

Agents cannot subscribe to human plans.

curl example

curl -X GET "https://api.fast.io/current/org/billing/plan/list/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "results": 3,
    "defaults": {
      "pro": "pro_monthly",
      "business": "business_monthly"
    },
    "plans": [
      {
        "id": "free",
        "name": "Free",
        "category": "free",
        "amount": 0
      },
      {
        "id": "pro_monthly",
        "name": "Pro",
        "category": "pro",
        "amount": 2900
      },
      {
        "id": "business_monthly",
        "name": "Business",
        "category": "business",
        "amount": 4900
      }
    ]
  }
}

Response fields

FieldTypeDescription
resultsintegerNumber of available plans
defaultsobjectDefault plan IDs per category (pro, business)
plansarrayArray of plan detail objects
plans[].idstringPlan identifier (use in subscription requests)
plans[].namestringDisplay name
plans[].categorystringPlan category: "free", "pro", "business", "agent"
plans[].amountintegerPrice in cents (e.g., 2900 = $29.00)

List Invoices

GET /current/org/{org_id}/billing/invoices/

Auth required. Admin or above. Returns a paginated list of invoices with hosted payment links.

Query parameters

NameTypeDefaultDescription
limitinteger10Number of invoices to return (1-100)
starting_afterstringInvoice ID cursor for pagination

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/billing/invoices/?limit=10" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "invoices": [
      {
        "id": "in_1234567890",
        "status": "paid",
        "currency": "usd",
        "amount_due": 2900,
        "amount_paid": 2900,
        "subtotal": 2900,
        "total": 2900,
        "paid": true,
        "description": "Subscription creation",
        "hosted_invoice_url": "https://invoice.stripe.com/i/acct_xxx/...",
        "invoice_pdf": "https://pay.stripe.com/invoice/acct_xxx/...",
        "period_start": "2026-03-01 00:00:00 UTC",
        "period_end": "2026-04-01 00:00:00 UTC",
        "created": "2026-03-01 00:00:00 UTC"
      }
    ],
    "has_more": false
  }
}

Response fields

FieldTypeDescription
invoicesarrayArray of invoice objects
invoices[].idstringInvoice identifier (use as starting_after cursor)
invoices[].statusstring"draft", "open", "paid", "void", "uncollectible"
invoices[].currencystringThree-letter ISO currency code (e.g., "usd")
invoices[].amount_dueintegerAmount due in cents
invoices[].amount_paidintegerAmount paid in cents
invoices[].subtotalintegerSubtotal before tax in cents
invoices[].totalintegerTotal after tax in cents
invoices[].paidbooleanWhether the invoice has been paid
invoices[].descriptionstring/nullInvoice description
invoices[].hosted_invoice_urlstring/nullURL to view and pay the invoice
invoices[].invoice_pdfstring/nullDirect PDF download URL
invoices[].period_startstring/nullBilling period start (YYYY-MM-DD HH:MM:SS UTC)
invoices[].period_endstring/nullBilling period end (YYYY-MM-DD HH:MM:SS UTC)
invoices[].createdstring/nullInvoice creation timestamp (YYYY-MM-DD HH:MM:SS UTC)
has_morebooleanWhether more invoices are available for pagination

Amounts are in the smallest currency unit (cents for USD). Use hosted_invoice_url to link users to their invoices. Use starting_after with the last invoice id for pagination.


Create Workspace (from Org)

POST /current/org/{org_id}/create/workspace/

Auth required. Member or above. Creates a workspace within the org. Subject to plan feature availability and workspace creation limits.

Request parameters

NameTypeRequiredDescription
folder_namestringYesURL-safe folder name for the workspace. Must be globally unique across all workspaces.
namestringYesDisplay name.
descriptionstringNoWorkspace description.
perm_joinstringYesWho can auto-join from the org. Values: 'Member or above' (default), 'Admin or above', 'Only Org Owners'.
perm_member_managestringYesWho can manage workspace members. Values: 'Member or above' (default), 'Admin or above'.
intelligencestringYes (non-agents)Enable AI features ("true"/"false"). Defaults to "true" for agent accounts.
accent_colorstring (JSON)NoAccent color as JSON.
background_color1string (JSON)NoPrimary background color as JSON.
background_color2string (JSON)NoSecondary background color as JSON.

curl example

curl -X POST "https://api.fast.io/current/org/1234567890123456789/create/workspace/" \
  -H "Authorization: Bearer {jwt_token}" \
  -d "folder_name=project-alpha" \
  -d "name=Project Alpha" \
  -d "perm_join=Member or above" \
  -d "perm_member_manage=Admin or above" \
  -d "intelligence=true"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "workspace": {
      "id": "1234567890123456780",
      "folder_name": "project-alpha"
    }
  }
}

Response fields

FieldTypeDescription
workspace.idstring19-digit numeric workspace ID
workspace.folder_namestringURL-safe folder name

Error responses

Error CodeHTTP StatusMessageCause
1685 (Feature Limit)403"Workspace creation is not available on your current plan."Feature disabled
1685 (Feature Limit)403"You have reached your workspace creation limit."Limit exceeded
1658 (Not Acceptable)406"The supplied workspace folder name is already in use."Duplicate folder name
1605 (Invalid Input)400"An invalid workspace folder name was supplied."Invalid folder name
1605 (Invalid Input)400"An invalid configuration was supplied..."Metadata validation failed

List Workspaces in Org

GET /current/org/{org_id}/list/workspaces/

Auth required. Lists accessible workspaces within the org.

Query parameters

NameTypeDefaultDescription
archivedstring"false""true" to show archived workspaces, "false" for active

Access levels

RoleAccessNotes
OwnerFull accessSees all workspaces
AdminFull accessSees all workspaces
MemberFilteredSees workspaces matching join permission level
ExternalFilteredSees only workspaces where they are a direct member

curl example

curl -X GET "https://api.fast.io/current/org/1234567890123456789/list/workspaces/" \
  -H "Authorization: Bearer {jwt_token}"

Response (200 OK)

{
  "result": "yes",
  "response": {
    "workspaces": [
      {
        "id": "1234567890123456780",
        "folder_name": "project-alpha",
        "name": "Project Alpha",
        "description": "Main project workspace"
      }
    ]
  }
}

Response fields

FieldTypeDescription
workspacesarrayArray of workspace objects
workspaces[].idstring19-digit numeric workspace ID
workspaces[].folder_namestringURL-safe folder name
workspaces[].namestringDisplay name
workspaces[].descriptionstring/nullWorkspace description
↑ Back to top