PerfectWorks
  1. Organizations
PerfectWorks
  • Organizations
    • Register new organization
      POST
    • List user's organizations
      GET
    • Get current organization details
      GET
    • Update organization profile
      PUT
    • Get organization statistics
      GET
    • Get organization by slug (public)
      GET
    • Soft delete organization
      DELETE
    • Permanently delete organization
      DELETE
  • Files
    • Generate signed upload URL
      POST
    • Create file record
      POST
    • List files
      GET
    • Get file by ID
      GET
    • Update file
      PUT
    • Delete file
      DELETE
    • Generate download URL
      POST
    • Analyze file
      POST
    • Process file for accessibility
      POST
    • Convert file to different format
      POST
  • API Keys
    • Create a new API key
      POST
    • List user's API keys
      GET
    • Get API key by ID
      GET
    • Update API key description
      PUT
    • Delete API key
      DELETE
  • Referrers
    • Join referral program
      POST
    • Get referrer profile
      GET
    • Get referrer dashboard
      GET
  • Referrer Transactions
    • List referrer's transactions
    • Get transaction details
    • Request withdrawal from pending earnings
  • Referrer Campaigns
    • Create referral campaign
    • List referrer's campaigns
    • Get campaign details
    • Update campaign
    • End campaign
    • Get campaign analytics
  • Referral Links
    • Track referral click and redirect
  • Payments
    • Create a checkout session
    • Get checkout session details
    • Get available products
  • Users
    • Register new client user
    • Register system user
    • Get user profile
    • Update user profile
    • Soft delete user account
    • Permanently delete user account
    • Switch active organization
    • Get current active organization
  • Token Transactions
    • List organization token transactions
    • Get organization token balance
    • Get token transaction by ID
  • Organization Members
    • Invite new member to organization
    • List organization members
    • Get user's pending organization invitations
    • Get member details
    • Remove organization member
    • Join organization with pending invitation
  1. Organizations

Register new organization

POST
/organizations/register
Register a new organization. This endpoint is used after Firebase authentication
to complete organization setup. The Firebase UID and email are automatically
extracted from the JWT token.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.perfectworks.io/api/v0/organizations/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corporation",
    "slug": "acme-corp",
    "email": "contact@acme.com",
    "phoneNumber": "+1-555-123-4567",
    "description": "Leading provider of innovative solutions",
    "logo": "https://example.com/logo.png",
    "referralCampaignCode": "PARTNER2024"
}'
Response Response Example
201 - Example 1
{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/json

Examples

Responses

🟢201Created
application/json
Organization registered successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠409409
🔴500Server Error
Modified at 2025-08-22 18:48:44
Next
List user's organizations