organization

Workspace API

---

Workspace API / types/organization

types/organization

Interfaces

Organization

Defined in: types/organization.ts:2

Properties

organization_id

organization_id: string

Defined in: types/organization.ts:3

name

name: string

Defined in: types/organization.ts:4

slug

slug: string

Defined in: types/organization.ts:5

description?

optional description: string

Defined in: types/organization.ts:6

email?

optional email: string

Defined in: types/organization.ts:7

phone?

optional phone: string

Defined in: types/organization.ts:8

website?

optional website: string

Defined in: types/organization.ts:9

address_line1?

optional address_line1: string

Defined in: types/organization.ts:10

address_line2?

optional address_line2: string

Defined in: types/organization.ts:11

city?

optional city: string

Defined in: types/organization.ts:12

state?

optional state: string

Defined in: types/organization.ts:13

postal_code?

optional postal_code: string

Defined in: types/organization.ts:14

country?

optional country: string

Defined in: types/organization.ts:15

status

status: "active" | "inactive" | "suspended" | "trial"

Defined in: types/organization.ts:16

trial_ends_at?

optional trial_ends_at: Date

Defined in: types/organization.ts:17

created_at

created_at: Date

Defined in: types/organization.ts:18

updated_at

updated_at: Date

Defined in: types/organization.ts:19

created_by?

optional created_by: string

Defined in: types/organization.ts:20

---

CreateOrganizationData

Defined in: types/organization.ts:23

Properties

name

name: string

Defined in: types/organization.ts:24

description?

optional description: string

Defined in: types/organization.ts:25

email?

optional email: string

Defined in: types/organization.ts:26

phone?

optional phone: string

Defined in: types/organization.ts:27

website?

optional website: string

Defined in: types/organization.ts:28

address_line1?

optional address_line1: string

Defined in: types/organization.ts:29

address_line2?

optional address_line2: string

Defined in: types/organization.ts:30

city?

optional city: string

Defined in: types/organization.ts:31

state?

optional state: string

Defined in: types/organization.ts:32

postal_code?

optional postal_code: string

Defined in: types/organization.ts:33

country?

optional country: string

Defined in: types/organization.ts:34

created_by?

optional created_by: string

Defined in: types/organization.ts:35

---

UpdateOrganizationData

Defined in: types/organization.ts:38

Properties

name?

optional name: string

Defined in: types/organization.ts:39

description?

optional description: string

Defined in: types/organization.ts:40

email?

optional email: string

Defined in: types/organization.ts:41

phone?

optional phone: string

Defined in: types/organization.ts:42

website?

optional website: string

Defined in: types/organization.ts:43

address_line1?

optional address_line1: string

Defined in: types/organization.ts:44

address_line2?

optional address_line2: string

Defined in: types/organization.ts:45

city?

optional city: string

Defined in: types/organization.ts:46

state?

optional state: string

Defined in: types/organization.ts:47

postal_code?

optional postal_code: string

Defined in: types/organization.ts:48

country?

optional country: string

Defined in: types/organization.ts:49

status?

optional status: "active" | "inactive" | "suspended" | "trial"

Defined in: types/organization.ts:50

trial_ends_at?

optional trial_ends_at: Date

Defined in: types/organization.ts:51

---

OrganizationFilters

Defined in: types/organization.ts:54

Properties

status?

optional status: "active" | "inactive" | "suspended" | "trial"

Defined in: types/organization.ts:55

name?

optional name: string

Defined in: types/organization.ts:56

email?

optional email: string

Defined in: types/organization.ts:57

limit?

optional limit: number

Defined in: types/organization.ts:58

offset?

optional offset: number

Defined in: types/organization.ts:59

---

UserOrganization

Defined in: types/organization.ts:62

Properties

user_organization_id

user_organization_id: string

Defined in: types/organization.ts:63

user_id

user_id: string

Defined in: types/organization.ts:64

organization_id

organization_id: string

Defined in: types/organization.ts:65

role

role: "admin" | "member" | "guest"

Defined in: types/organization.ts:66

is_active

is_active: boolean

Defined in: types/organization.ts:67

joined_at

joined_at: Date

Defined in: types/organization.ts:68

invited_by?

optional invited_by: string

Defined in: types/organization.ts:69

invited_at?

optional invited_at: Date

Defined in: types/organization.ts:70

created_at

created_at: Date

Defined in: types/organization.ts:71

updated_at

updated_at: Date

Defined in: types/organization.ts:72

---

OrganizationMember

Defined in: types/organization.ts:75

Extended by

• OrganizationMemberWithDetails

Properties

user_id

user_id: string

Defined in: types/organization.ts:76

email

email: string

Defined in: types/organization.ts:77

first_name?

optional first_name: string

Defined in: types/organization.ts:78

last_name?

optional last_name: string

Defined in: types/organization.ts:79

role

role: "admin" | "member" | "guest"

Defined in: types/organization.ts:80

is_active

is_active: boolean

Defined in: types/organization.ts:81

joined_at

joined_at: Date

Defined in: types/organization.ts:82

invited_by?

optional invited_by: string

Defined in: types/organization.ts:83

---

OrganizationStats

Defined in: types/organization.ts:86

Properties

total_members

total_members: number

Defined in: types/organization.ts:87

active_members

active_members: number

Defined in: types/organization.ts:88

admin_count

admin_count: number

Defined in: types/organization.ts:89

member_count

member_count: number

Defined in: types/organization.ts:90

guest_count

guest_count: number

Defined in: types/organization.ts:91

total_projects

total_projects: number

Defined in: types/organization.ts:92

active_projects

active_projects: number

Defined in: types/organization.ts:93

---

OrganizationMemberWithDetails

Defined in: types/organization.ts:96

Extends

• OrganizationMember

Properties

user_id

user_id: string

Defined in: types/organization.ts:76

Inherited from

OrganizationMember.user_id

email

email: string

Defined in: types/organization.ts:77

Inherited from

OrganizationMember.email

first_name?

optional first_name: string

Defined in: types/organization.ts:78

Inherited from

OrganizationMember.first_name

last_name?

optional last_name: string

Defined in: types/organization.ts:79

Inherited from

OrganizationMember.last_name

role

role: "admin" | "member" | "guest"

Defined in: types/organization.ts:80

Inherited from

OrganizationMember.role

is_active

is_active: boolean

Defined in: types/organization.ts:81

Inherited from

OrganizationMember.is_active

joined_at

joined_at: Date

Defined in: types/organization.ts:82

Inherited from

OrganizationMember.joined_at

invited_by?

optional invited_by: string

Defined in: types/organization.ts:83

Inherited from

OrganizationMember.invited_by

status

status: "active" | "inactive" | "suspended" | "pending"

Defined in: types/organization.ts:97

created_at

created_at: Date

Defined in: types/organization.ts:98

updated_at

updated_at: Date

Defined in: types/organization.ts:99

last_login_at?

optional last_login_at: Date

Defined in: types/organization.ts:100

---

OrganizationResponse

Defined in: types/organization.ts:104

Properties

id

id: string

Defined in: types/organization.ts:105

name

name: string

Defined in: types/organization.ts:106

slug

slug: string

Defined in: types/organization.ts:107

description?

optional description: string

Defined in: types/organization.ts:108

email?

optional email: string

Defined in: types/organization.ts:109

phone?

optional phone: string

Defined in: types/organization.ts:110

website?

optional website: string

Defined in: types/organization.ts:111

addressLine1?

optional addressLine1: string

Defined in: types/organization.ts:112

addressLine2?

optional addressLine2: string

Defined in: types/organization.ts:113

city?

optional city: string

Defined in: types/organization.ts:114

state?

optional state: string

Defined in: types/organization.ts:115

postalCode?

optional postalCode: string

Defined in: types/organization.ts:116

country?

optional country: string

Defined in: types/organization.ts:117

status

status: "active" | "inactive" | "suspended" | "trial"

Defined in: types/organization.ts:118

trialEndsAt?

optional trialEndsAt: Date

Defined in: types/organization.ts:119

createdAt

createdAt: Date

Defined in: types/organization.ts:120

updatedAt

updatedAt: Date

Defined in: types/organization.ts:121

createdBy?

optional createdBy: string

Defined in: types/organization.ts:122

---

CreateOrganizationRequest

Defined in: types/organization.ts:125

Properties

name

name: string

Defined in: types/organization.ts:126

description?

optional description: string

Defined in: types/organization.ts:127

email?

optional email: string

Defined in: types/organization.ts:128

phone?

optional phone: string

Defined in: types/organization.ts:129

website?

optional website: string

Defined in: types/organization.ts:130

addressLine1?

optional addressLine1: string

Defined in: types/organization.ts:131

addressLine2?

optional addressLine2: string

Defined in: types/organization.ts:132

city?

optional city: string

Defined in: types/organization.ts:133

state?

optional state: string

Defined in: types/organization.ts:134

postalCode?

optional postalCode: string

Defined in: types/organization.ts:135

country?

optional country: string

Defined in: types/organization.ts:136

---

UpdateOrganizationRequest

Defined in: types/organization.ts:139

Properties

name?

optional name: string

Defined in: types/organization.ts:140

description?

optional description: string

Defined in: types/organization.ts:141

email?

optional email: string

Defined in: types/organization.ts:142

phone?

optional phone: string

Defined in: types/organization.ts:143

website?

optional website: string

Defined in: types/organization.ts:144

addressLine1?

optional addressLine1: string

Defined in: types/organization.ts:145

addressLine2?

optional addressLine2: string

Defined in: types/organization.ts:146

city?

optional city: string

Defined in: types/organization.ts:147

state?

optional state: string

Defined in: types/organization.ts:148

postalCode?

optional postalCode: string

Defined in: types/organization.ts:149

country?

optional country: string

Defined in: types/organization.ts:150

status?

optional status: "active" | "inactive" | "suspended" | "trial"

Defined in: types/organization.ts:151

trialEndsAt?

optional trialEndsAt: Date

Defined in: types/organization.ts:152