Zum Hauptinhalt springen

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:

SettingTypeDescription
currencystringDefault currency (USD, EUR, etc.)
defaultValueDateTypeenumDate type: TODAY, END_OF_MONTH
startWeekOnenumWeek start day
bonusTypeenumBonus calculation: PROFIT_BASED, REVENUE_BASED
bonusPercentagenumberDefault bonus percentage
timeZonestringOrganization timezone
regionCodestringRegion/country code
fiscalStartDatedateFiscal year start
fiscalEndDatedateFiscal year end
invitesAllowedbooleanAllow user invitations
inviteExpiryPeriodnumberInvitation expiry days

Required Permissions

EndpointPermission
GET /api/organizationORG_VIEW (or member of org)
POST /api/organizationORG_EDIT (Admin+)
PUT /api/organization/:idORG_EDIT
DELETE /api/organization/:idSUPER_ADMIN only