Organizations

Create a new organization

post

Authorizations

apiAuth

Body

application/json

namestringRequiredExample: My Organization

countryCodestringRequiredExample: US

Responses

201

Organization created

post

/api/organizations

HTTPcURLJavaScriptPython

POST /api/organizations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "My Organization",
  "countryCode": "US"
}

201

Organization created

No content

Get an organization by ID

get

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

The organization ID

Responses

200

Organization found

application/json

Organization details

idstring · uuidRequired

Unique identifier for the organization

Example: 123e4567-e89b-12d3-a456-426614174000

namestringRequired

The name of the organization

Example: My Organization

avatarUrlstring · url · nullableOptional

URL of the organization's avatar

Example: https://example.com/avatar.png

statusstringRequired

The current status of the organization

Example: active

typestringOptional

The current status of the organization

Example: active

ownerstring · idRequired

UUID of the user who owns the organization

Example: 123e4567-e89b-12d3-a456-426614174000

get

/api/organizations/{organizationId}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId} HTTP/1.1
Accept: */*

200

Organization found

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Organization",
  "avatarUrl": "https://example.com/avatar.png",
  "status": "active",
  "type": "active",
  "owner": "123e4567-e89b-12d3-a456-426614174000"
}

Update an organization's details

patch

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

The organization ID

Body

application/json

namestringOptionalExample: Updated Organization Name

avatarUrlstringOptionalExample: https://example.com/avatar.jpg

statusstring · enumOptionalExample: activePossible values:

statusReasonstringOptionalExample: Violation of terms

Responses

200

Organization updated

application/json

Organization details

idstring · uuidRequired

Unique identifier for the organization

Example: 123e4567-e89b-12d3-a456-426614174000

namestringRequired

The name of the organization

Example: My Organization

avatarUrlstring · url · nullableOptional

URL of the organization's avatar

Example: https://example.com/avatar.png

statusstringRequired

The current status of the organization

Example: active

typestringOptional

The current status of the organization

Example: active

ownerstring · idRequired

UUID of the user who owns the organization

Example: 123e4567-e89b-12d3-a456-426614174000

patch

/api/organizations/{organizationId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "name": "Updated Organization Name",
  "avatarUrl": "https://example.com/avatar.jpg",
  "status": "active",
  "statusReason": "Violation of terms"
}

200

Organization updated

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Organization",
  "avatarUrl": "https://example.com/avatar.png",
  "status": "active",
  "type": "active",
  "owner": "123e4567-e89b-12d3-a456-426614174000"
}

Upload media for an organization

post

Authorizations

apiAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

Body

multipart/form-data

filefileOptional

File to be uploaded

Responses

200

File uploaded successfully

No content

post

/api/organizations/{organization}/upload-avatar

HTTPcURLJavaScriptPython

POST /api/organizations/{organization}/upload-avatar HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 13

{
  "file": null
}

200

File uploaded successfully

No content

Get all members of an organization with pagination

get

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization

Query parameters

pageintegerOptional

Page number for pagination

Default: 1

per_pageintegerOptional

Number of members per page

Default: 15

Responses

200

List of organization members

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: All Organization Members

404

Organization not found

application/json

get

/api/organizations/{organizationId}/members

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/members HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "All Organization Members",
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "[email protected]",
      "status": "active",
      "roles": [
        "Admin"
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Update a member's roles and workspaces in an organization

put

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

memberIdintegerRequired

ID of the member to be updated

Body

application/json

workspacesstring · uuid[]Required

Array of workspace IDs

rolesinteger[]Required

Array of IAM role IDs

Responses

200

Member updated successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Member update

dataobjectOptional

400

Validation error

application/json

404

Member not found

application/json

put

/api/organizations/{organizationId}/members/{memberId}

HTTPcURLJavaScriptPython

PUT /api/organizations/{organizationId}/members/{memberId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "workspaces": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "roles": [
    1
  ]
}

{
  "success": true,
  "message": "Member update",
  "data": {}
}

Delete a member from an organization

delete

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization

memberIdintegerRequired

ID of the member to be deleted

Responses

200

Member deleted successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Member deleted successfully

404

Organization or Member not found

application/json

delete

/api/organizations/{organizationId}/members/{memberId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/members/{memberId} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Member deleted successfully"
}

Charge an organization's wallet

post

Authorizations

apiAuth

Path parameters

organizationstring · uuidRequired

Organization UUID

Body

application/json

amountintegerRequired

Amount to charge

Example: 1000

servicestring · enumRequired

Service type

Example: smsPossible values:

sms_pointintegerOptional

Required when service is 'sms'. Number of SMS points

Example: 100

reasonstringOptional

Optional reason for the charge

Example: Monthly SMS package

Responses

200

Charge processed successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Charge processed successfully

datanullOptional

422

Validation error

application/json

500

Error processing charge

application/json

post

/api/admin/organizations/{organization}/charge

HTTPcURLJavaScriptPython

POST /api/admin/organizations/{organization}/charge HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "amount": 1000,
  "service": "sms",
  "sms_point": 100,
  "reason": "Monthly SMS package"
}

{
  "success": true,
  "message": "Charge processed successfully",
  "data": null
}

Invite a new user to the organization

post

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization to invite the user to

Body

application/json

emailstringOptionalExample: [email protected]

namestringOptionalExample: John Doe

rolesinteger[]OptionalExample: 1

Responses

200

Invitation sent successfully.

No content

400

Validation Error(s).

post

/api/organizations/{organizationId}/invite

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/invite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "email": "[email protected]",
  "name": "John Doe",
  "roles": [
    1
  ]
}

No content

Accept the invitation and set the password

post

Path parameters

inviteTokenstringRequired

Invite token sent to the user

Body

application/json

passwordstringOptionalExample: password123

password_confirmationstringOptionalExample: password123

Responses

200

Password set successfully.

No content

400

Invalid invite token.

post

/api/organizations/invite/{inviteToken}/accept

HTTPcURLJavaScriptPython

POST /api/organizations/invite/{inviteToken}/accept HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "password": "password123",
  "password_confirmation": "password123"
}

No content