Circle V2 API Docs
Preparing search index...
@repo/trpc
routers/org-members/index
orgMembersRouter
Variable orgMembersRouter
Const
orgMembersRouter
:
BuiltRouter
<
{
ctx
:
TRPCContext
;
errorShape
:
DefaultErrorShape
;
meta
:
object
;
transformer
:
false
;
}
,
DecorateCreateRouterOptions
<
{
createInvite
:
MutationProcedure
<
{
input
:
{
email
:
string
;
firstName
:
string
;
lastName
:
string
;
roleId
:
number
;
title
?:
string
;
}
;
meta
:
object
;
output
:
InviteUserServiceResult
;
}
,
>
;
getMemberByProfileId
:
QueryProcedure
<
{
input
:
{
profileId
:
string
}
;
meta
:
object
;
output
:
{
email
:
string
|
null
;
first_name
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
role
:
UserRole
;
role_id
:
number
&
{
__brand
:
"RoleId"
}
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
}
;
}
,
>
;
listPendingInvites
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
sortBy
?:
"name"
|
"email"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
email
:
string
;
first_name
:
string
|
null
;
id
:
PendingInviteId
;
last_name
:
string
|
null
;
role_id
:
number
;
role_name
:
string
|
null
;
title
:
string
|
null
;
}
,
>
;
}
,
>
;
listRoles
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
search
?:
string
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
role_id
:
RoleId
;
role_name
:
string
}
>
;
}
,
>
;
listUsers
:
QueryProcedure
<
{
input
:
{
cursor
?:
number
;
limit
?:
number
;
offset
?:
number
;
roleId
?:
unknown
;
search
?:
string
;
sortBy
?:
"name"
|
"email"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
email
:
string
|
null
;
first_name
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
role
:
UserRole
;
role_id
:
number
&
{
__brand
:
"RoleId"
}
;
role_name
:
string
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
}
,
>
;
}
,
>
;
removeMember
:
MutationProcedure
<
{
input
:
{
profileId
:
string
}
;
meta
:
object
;
output
:
{
profileId
:
ProfileId
}
;
}
,
>
;
resendInvite
:
MutationProcedure
<
{
input
:
{
pendingInviteId
:
number
}
;
meta
:
object
;
output
:
ResendInviteServiceResult
;
}
,
>
;
updateMember
:
MutationProcedure
<
{
input
:
{
email
:
string
;
firstName
:
string
;
isSuperadmin
:
boolean
;
lastName
:
string
;
profileId
:
string
;
role
:
"individual"
|
"supervisor"
|
"admin"
;
title
?:
string
;
}
;
meta
:
object
;
output
:
{
email
:
string
|
null
;
first_name
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
role
:
UserRole
;
role_id
:
number
&
{
__brand
:
"RoleId"
}
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
}
;
}
,
>
;
}
,
>
,
>
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Circle V2 API Docs
Loading...