Organization Endpoints
API endpoints for organization management, departments, teams, and settings.
Organization CRUDโ
List Organizationsโ
GET /api/organization?take=10&skip=0
Authorization: Bearer {token}
Response (200 OK):
{
"items": [
{
"id": "...",
"name": "Ever Technologies",
"currency": "USD",
"defaultValueDateType": "TODAY",
"isActive": true,
"totalEmployees": 25,
"tenantId": "..."
}
],
"total": 3
}
Get Organization by IDโ
GET /api/organization/{id}?relations[]=contact
Authorization: Bearer {token}
Create Organizationโ
POST /api/organization
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "New Division",
"currency": "USD",
"defaultValueDateType": "TODAY",
"imageUrl": "https://example.com/logo.png"
}
Update Organizationโ
PUT /api/organization/{id}
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "Updated Division Name",
"officialName": "Updated Division Official Name LLC"
}
Delete Organizationโ
DELETE /api/organization/{id}
Authorization: Bearer {token}
Departmentsโ
List Departmentsโ
GET /api/organization-department?where[organizationId]={org-id}
Authorization: Bearer {token}
Create Departmentโ
POST /api/organization-department
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "Engineering",
"organizationId": "org-uuid"
}
Teamsโ
List Teamsโ
GET /api/organization-team?where[organizationId]={org-id}
Authorization: Bearer {token}
Create Teamโ
POST /api/organization-team
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "Backend Team",
"organizationId": "org-uuid",
"members": [
{ "id": "employee-uuid-1", "role": 0 },
{ "id": "employee-uuid-2", "role": 1 }
]
}
Team Join Requestโ
POST /api/organization-team-join-request
Authorization: Bearer {token}
Content-Type: application/json
{
"organizationTeamId": "team-uuid",
"organizationId": "org-uuid"
}
Projectsโ
List Projectsโ
GET /api/organization-projects?where[organizationId]={org-id}
Authorization: Bearer {token}
Create Projectโ
POST /api/organization-projects
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "Gauzy Platform",
"organizationId": "org-uuid",
"membersCount": 10,
"billing": "RATE",
"currency": "USD"
}
Vendorsโ
List Vendorsโ
GET /api/organization-vendors?where[organizationId]={org-id}
Authorization: Bearer {token}
Employment Typesโ
List Employment Typesโ
GET /api/organization-employment-type
Authorization: Bearer {token}
Organization Documentsโ
List Documentsโ
GET /api/organization-document?where[organizationId]={org-id}
Authorization: Bearer {token}
Upload Documentโ
POST /api/organization-document
Authorization: Bearer {token}
Content-Type: application/json
{
"name": "Employee Handbook",
"documentUrl": "https://...",
"organizationId": "org-uuid"
}
Organization Settingsโ
Key organization-level settings managed through the Organization entity:
| Setting | Type | Description |
|---|---|---|
currency | string | Default currency (USD, EUR, etc.) |
defaultValueDateType | enum | Date type: TODAY, END_OF_MONTH |
startWeekOn | enum | Week start day |
bonusType | enum | Bonus calculation: PROFIT_BASED, REVENUE_BASED |
bonusPercentage | number | Default bonus percentage |
timeZone | string | Organization timezone |
regionCode | string | Region/country code |
fiscalStartDate | date | Fiscal year start |
fiscalEndDate | date | Fiscal year end |
invitesAllowed | boolean | Allow user invitations |
inviteExpiryPeriod | number | Invitation expiry days |
Required Permissionsโ
| Endpoint | Permission |
|---|---|
GET /api/organization | ORG_VIEW (or member of org) |
POST /api/organization | ORG_EDIT (Admin+) |
PUT /api/organization/:id | ORG_EDIT |
DELETE /api/organization/:id | SUPER_ADMIN only |