Team
Members, roles, invites.
7 نقاط وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.
GET /v1/team/membersPATCH /v1/team/members/{membership_id}DELETE /v1/team/members/{membership_id}GET /v1/team/invitesPOST /v1/team/invitesDELETE /v1/team/invites/{invite_id}POST /v1/team/invites/accept
GET
/v1/team/membersTeam Members List
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
الردود
- 200Successful Response
MemberOut[]
PATCH
/v1/team/members/{membership_id}Team Members Update
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
membership_id | path | string | نعم |
جسم الطلب application/json MemberUpdate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
role | "owner" | "admin" | "editor" | "viewer" | نعم |
الردود
- 200Successful Response
MemberOut
DELETE
/v1/team/members/{membership_id}Team Members Remove
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
membership_id | path | string | نعم |
الردود
- 200Successful Response
Deleted
GET
/v1/team/invitesTeam Invites List
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
الردود
- 200Successful Response
InviteOut[]
POST
/v1/team/invitesTeam Invites Create
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
جسم الطلب application/json InviteCreate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
email | string (email) | نعم | |
role | "admin" | "editor" | "viewer" | نعم |
الردود
- 201Successful Response
InviteOut
DELETE
/v1/team/invites/{invite_id}Team Invites Revoke
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
invite_id | path | string | نعم |
الردود
- 200Successful Response
Deleted
POST
/v1/team/invites/acceptTeam Invites Accept
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
جسم الطلب application/json TokenRequest
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
token | string | نعم | min length 20 · max length 200 |
الردود
- 200Successful Response
TenantOut
أشكال البيانات في هذه الصفحة
MemberOut
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
user_id | string | نعم | |
email | string | نعم | |
name | string | null | نعم | |
role | "owner" | "admin" | "editor" | "viewer" | نعم | |
created_at | string (date-time) | نعم |
MemberUpdate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
role | "owner" | "admin" | "editor" | "viewer" | نعم |
Deleted
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
deleted | boolean | لا | default true |
id | string | نعم |
InviteOut
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
email | string | نعم | |
role | "owner" | "admin" | "editor" | "viewer" | نعم | |
expires_at | string (date-time) | نعم | |
created_at | string (date-time) | نعم |
InviteCreate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
email | string (email) | نعم | |
role | "admin" | "editor" | "viewer" | نعم |
TokenRequest
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
token | string | نعم | min length 20 · max length 200 |
TenantOut
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
slug | string | نعم | |
name | string | نعم | |
status | "trialing" | "active" | "past_due" | "suspended" | "canceled" | "deleted" | نعم | |
plan_code | string | نعم | |
default_locale | string | نعم | |
locales | string[] | نعم | |
currency | string | نعم | |
trial_ends_at | string (date-time) | null | لا | |
created_at | string (date-time) | نعم |