GraphQL API Reference
Welcome to the party!
Terms of Service
API Endpoints
https://snapshot.roq-platform.com/v01/server/graphqlQueries
checkUserInviteToken
Response
Returns a
CheckUserInviteTokenModel!
Arguments
| Name | Description |
|---|---|
token -
String!
|
Example
Query
query checkUserInviteToken($token: String!) {
checkUserInviteToken(token: $token) {
isValid
isExpired
email
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"checkUserInviteToken": {
"isValid": false,
"isExpired": true,
"email": "xyz789"
}
}
}
conversations
Response
Returns a
ConversationPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
ConversationSearchArgType
|
|
order -
ConversationOrderArgType
|
|
filter -
ConversationFilterArgType
|
Example
Query
query conversations(
$limit: Int,
$offset: Int,
$search: ConversationSearchArgType,
$order: ConversationOrderArgType,
$filter: ConversationFilterArgType
) {
conversations(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...ConversationModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"search": ConversationSearchArgType,
"order": ConversationOrderArgType,
"filter": ConversationFilterArgType
}
Response
{
"data": {
"conversations": {
"totalCount": 987.65,
"data": [ConversationModel]
}
}
}
file
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query file($id: ID!) {
file(id: $id) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"file": {
"id": "4",
"name": "abc123",
"status": "cancelled",
"createdByUserId": "4",
"fileCategoryId": "4",
"contentType": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"url": "xyz789",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
fileCategories
Response
Returns a
FileCategoryPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
FileCategorySearchArgType
|
|
order -
FileCategoryOrderArgType
|
|
filter -
FileCategoryFilterArgType
|
Example
Query
query fileCategories(
$limit: Int,
$offset: Int,
$search: FileCategorySearchArgType,
$order: FileCategoryOrderArgType,
$filter: FileCategoryFilterArgType
) {
fileCategories(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...FileCategoryModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"search": FileCategorySearchArgType,
"order": FileCategoryOrderArgType,
"filter": FileCategoryFilterArgType
}
Response
{
"data": {
"fileCategories": {
"totalCount": 987,
"data": [FileCategoryModel]
}
}
}
fileCategory
Response
Returns a
FileCategoryModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query fileCategory($id: ID!) {
fileCategory(id: $id) {
id
name
key
maxSize
isPublicByDefault
fileCategoryContentGroups {
...FileCategoryContentGroupPageModelFragment
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"fileCategory": {
"id": "4",
"name": "abc123",
"key": "xyz789",
"maxSize": 987.65,
"isPublicByDefault": false,
"fileCategoryContentGroups": FileCategoryContentGroupPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
fileCategoryContentGroup
Response
Returns a
FileCategoryContentGroupModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query fileCategoryContentGroup($id: ID!) {
fileCategoryContentGroup(id: $id) {
id
key
name
createdAt
updatedAt
fileCategories {
...FileCategoryPageModelFragment
}
fileCategoryContentTypes {
...FileCategoryContentTypePageModelFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"fileCategoryContentGroup": {
"id": 4,
"key": "abc123",
"name": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"fileCategories": FileCategoryPageModel,
"fileCategoryContentTypes": FileCategoryContentTypePageModel
}
}
}
fileCategoryContentGroups
Response
Returns a
FileCategoryContentGroupPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
FileCategoryContentGroupSearchArgType
|
|
order -
FileCategoryContentGroupOrderArgType
|
|
filter -
FileCategoryContentGroupFilterArgType
|
Example
Query
query fileCategoryContentGroups(
$limit: Int,
$offset: Int,
$search: FileCategoryContentGroupSearchArgType,
$order: FileCategoryContentGroupOrderArgType,
$filter: FileCategoryContentGroupFilterArgType
) {
fileCategoryContentGroups(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...FileCategoryContentGroupModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"search": FileCategoryContentGroupSearchArgType,
"order": FileCategoryContentGroupOrderArgType,
"filter": FileCategoryContentGroupFilterArgType
}
Response
{
"data": {
"fileCategoryContentGroups": {
"totalCount": 987,
"data": [FileCategoryContentGroupModel]
}
}
}
fileCategoryContentTypes
Response
Returns a
FileCategoryContentTypePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
FileCategoryContentTypeSearchArgType
|
|
order -
FileCategoryContentTypeOrderArgType
|
|
filter -
FileCategoryContentTypeFilterArgType
|
Example
Query
query fileCategoryContentTypes(
$limit: Int,
$offset: Int,
$search: FileCategoryContentTypeSearchArgType,
$order: FileCategoryContentTypeOrderArgType,
$filter: FileCategoryContentTypeFilterArgType
) {
fileCategoryContentTypes(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...FileCategoryContentTypeModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"search": FileCategoryContentTypeSearchArgType,
"order": FileCategoryContentTypeOrderArgType,
"filter": FileCategoryContentTypeFilterArgType
}
Response
{
"data": {
"fileCategoryContentTypes": {
"totalCount": 123,
"data": [FileCategoryContentTypeModel]
}
}
}
files
Response
Returns a
FilePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
FileSearchArgType
|
|
order -
FileOrderArgType
|
|
filter -
FileFilterArgType
|
Example
Query
query files(
$limit: Int,
$offset: Int,
$search: FileSearchArgType,
$order: FileOrderArgType,
$filter: FileFilterArgType
) {
files(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...FileModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"search": FileSearchArgType,
"order": FileOrderArgType,
"filter": FileFilterArgType
}
Response
{
"data": {
"files": {"totalCount": 987, "data": [FileModel]}
}
}
isEntityPublic
isTenantsActive
Response
Returns a
Boolean!
Example
Query
query isTenantsActive {
isTenantsActive
}
Response
{"data": {"isTenantsActive": true}}
messageFileUrl
messages
Response
Returns a
MessagePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
MessageSearchArgType
|
|
order -
MessageOrderArgType
|
|
filter -
MessageFilterArgType
|
Example
Query
query messages(
$limit: Int,
$offset: Int,
$search: MessageSearchArgType,
$order: MessageOrderArgType,
$filter: MessageFilterArgType
) {
messages(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...MessageModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"search": MessageSearchArgType,
"order": MessageOrderArgType,
"filter": MessageFilterArgType
}
Response
{
"data": {
"messages": {
"totalCount": 987.65,
"data": [MessageModel]
}
}
}
notificationPreference
Response
Returns
[NotificationPreferenceModel!]!
Example
Query
query notificationPreference {
notificationPreference {
name
id
key
enabled
channelPreferences {
...ChannelPreferencePageModelFragment
}
}
}
Response
{
"data": {
"notificationPreference": [
{
"name": "abc123",
"id": "abc123",
"key": "xyz789",
"enabled": true,
"channelPreferences": ChannelPreferencePageModel
}
]
}
}
notifications
Response
Returns a
NotificationPageModel!
Example
Query
query notifications(
$page: Float,
$seen: Boolean
) {
notifications(
page: $page,
seen: $seen
) {
totalCount
data {
...NotificationModelFragment
}
}
}
Variables
{"page": 0, "seen": true}
Response
{
"data": {
"notifications": {
"totalCount": 987,
"data": [NotificationModel]
}
}
}
permissions
Response
Returns a
PermissionPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
PermissionSearchArgType
|
|
order -
PermissionOrderArgType
|
|
filter -
PermissionFilterArgType
|
Example
Query
query permissions(
$limit: Int,
$offset: Int,
$search: PermissionSearchArgType,
$order: PermissionOrderArgType,
$filter: PermissionFilterArgType
) {
permissions(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...PermissionModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"search": PermissionSearchArgType,
"order": PermissionOrderArgType,
"filter": PermissionFilterArgType
}
Response
{
"data": {
"permissions": {
"totalCount": 987,
"data": [PermissionModel]
}
}
}
projectEntities
Response
Returns a
ProjectEntityPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
filter -
ProjectEntityFilterArgType
|
|
order -
ProjectEntityOrderArgType
|
Example
Query
query projectEntities(
$limit: Int,
$offset: Int,
$filter: ProjectEntityFilterArgType,
$order: ProjectEntityOrderArgType
) {
projectEntities(
limit: $limit,
offset: $offset,
filter: $filter,
order: $order
) {
totalCount
data {
...ProjectEntityModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": ProjectEntityFilterArgType,
"order": ProjectEntityOrderArgType
}
Response
{
"data": {
"projectEntities": {
"totalCount": 123,
"data": [ProjectEntityModel]
}
}
}
projectEntity
Response
Returns a
ProjectEntityModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query projectEntity($id: ID!) {
projectEntity(id: $id) {
id
name
identifierField
isPublic
entityRelations {
...EntityRelationPageModelFragment
}
permissions {
...PermissionPageModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectEntity": {
"id": "4",
"name": "abc123",
"identifierField": "xyz789",
"isPublic": true,
"entityRelations": EntityRelationPageModel,
"permissions": PermissionPageModel
}
}
}
queryPlans
Response
Returns
[QueryPlanModel!]!
Example
Query
query queryPlans {
queryPlans {
queryPlan
kind
userIdField
role
entity
operation
scope
tenantName
tenantId
}
}
Response
{
"data": {
"queryPlans": [
{
"queryPlan": JsonObject,
"kind": "xyz789",
"userIdField": "abc123",
"role": "abc123",
"entity": "xyz789",
"operation": "xyz789",
"scope": "abc123",
"tenantName": "abc123",
"tenantId": "xyz789"
}
]
}
}
role
Response
Returns a
RoleModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query role($id: ID!) {
role(id: $id) {
id
key
name
projectEntityId
userIdField
reference
description
isSystemManaged
inviteRoleKeys
users {
...UsersCountModelFragment
}
userGroups {
...UserGroupPageModelFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"role": {
"id": 4,
"key": "abc123",
"name": "abc123",
"projectEntityId": "4",
"userIdField": "abc123",
"reference": "abc123",
"description": "abc123",
"isSystemManaged": true,
"inviteRoleKeys": ["xyz789"],
"users": UsersCountModel,
"userGroups": UserGroupPageModel
}
}
}
roles
Response
Returns a
RolePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
RoleSearchArgType
|
|
order -
RoleOrderArgType
|
|
filter -
RoleFilterArgType
|
Example
Query
query roles(
$limit: Int,
$offset: Int,
$search: RoleSearchArgType,
$order: RoleOrderArgType,
$filter: RoleFilterArgType
) {
roles(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...RoleModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"search": RoleSearchArgType,
"order": RoleOrderArgType,
"filter": RoleFilterArgType
}
Response
{
"data": {
"roles": {"totalCount": 987, "data": [RoleModel]}
}
}
tenant
Response
Returns a
TenantModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query tenant($id: ID!) {
tenant(id: $id) {
id
name
reference
isDefault
createdAt
updatedAt
users {
...UsersCountModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"tenant": {
"id": "4",
"name": "abc123",
"reference": "abc123",
"isDefault": false,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"users": UsersCountModel
}
}
}
tenants
Response
Returns a
TenantPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
filter -
TenantFilterArgType
|
|
order -
TenantOrderArgType
|
Example
Query
query tenants(
$limit: Int,
$offset: Int,
$filter: TenantFilterArgType,
$order: TenantOrderArgType
) {
tenants(
limit: $limit,
offset: $offset,
filter: $filter,
order: $order
) {
totalCount
data {
...TenantModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": TenantFilterArgType,
"order": TenantOrderArgType
}
Response
{
"data": {
"tenants": {"totalCount": 123, "data": [TenantModel]}
}
}
translation
Response
Returns a
TranslationModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query translation($id: ID!) {
translation(id: $id) {
id
key
value
locale
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"translation": {
"id": 4,
"key": "abc123",
"value": "xyz789",
"locale": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
translationKey
Response
Returns a
TranslationKeyModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query translationKey($id: ID!) {
translationKey(id: $id) {
id
key
translations {
...TranslationPageModelFragment
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"translationKey": {
"id": "4",
"key": "abc123",
"translations": TranslationPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
translationKeys
Response
Returns a
TranslationKeyPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
order -
TranslationKeyOrderArgType
|
|
filter -
TranslationKeyFilterArgType
|
|
searchTerm -
String
|
Example
Query
query translationKeys(
$limit: Int,
$offset: Int,
$order: TranslationKeyOrderArgType,
$filter: TranslationKeyFilterArgType,
$searchTerm: String
) {
translationKeys(
limit: $limit,
offset: $offset,
order: $order,
filter: $filter,
searchTerm: $searchTerm
) {
totalCount
data {
...TranslationKeyModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"order": TranslationKeyOrderArgType,
"filter": TranslationKeyFilterArgType,
"searchTerm": "xyz789"
}
Response
{
"data": {
"translationKeys": {
"totalCount": 987,
"data": [TranslationKeyModel]
}
}
}
translations
Response
Returns a
TranslationPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
filter -
TranslationFilterArgType
|
|
order -
TranslationOrderArgType
|
Example
Query
query translations(
$limit: Int,
$offset: Int,
$filter: TranslationFilterArgType,
$order: TranslationOrderArgType
) {
translations(
limit: $limit,
offset: $offset,
filter: $filter,
order: $order
) {
totalCount
data {
...TranslationModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"filter": TranslationFilterArgType,
"order": TranslationOrderArgType
}
Response
{
"data": {
"translations": {
"totalCount": 123,
"data": [TranslationModel]
}
}
}
user
Response
Returns a
UserModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query user($id: ID!) {
user(id: $id) {
id
email
reference
phone
firstName
lastName
locale
timezone
isOptedIn
synced
active
customData
avatarUrl
userGroups {
...UserGroupPageModelFragment
}
roles {
...RolePageModelFragment
}
tenantId
tenant {
...TenantModelFragment
}
twoFactorEnabled
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"user": {
"id": 4,
"email": "abc123",
"reference": "xyz789",
"phone": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"timezone": "abc123",
"isOptedIn": false,
"synced": false,
"active": false,
"customData": JsonObject,
"avatarUrl": "abc123",
"userGroups": UserGroupPageModel,
"roles": RolePageModel,
"tenantId": 4,
"tenant": TenantModel,
"twoFactorEnabled": true,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
userAccess
Response
Returns a
UserAccessModel!
Example
Query
query userAccess {
userAccess {
access
platform
project
}
}
Response
{
"data": {
"userAccess": {
"access": JsonObject,
"platform": JsonObject,
"project": JsonObject
}
}
}
userGroup
Response
Returns a
UserGroupModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query userGroup($id: ID!) {
userGroup(id: $id) {
id
type
name
reference
userGroupType {
...UserGroupTypeModelFragment
}
users {
...UserPageModelFragment
}
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"userGroup": {
"id": 4,
"type": "xyz789",
"name": "abc123",
"reference": "abc123",
"userGroupType": UserGroupTypeModel,
"users": UserPageModel,
"roles": RolePageModel
}
}
}
userGroups
Response
Returns a
UserGroupPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
UserGroupSearchArgType
|
|
order -
UserGroupOrderArgType
|
|
filter -
UserGroupFilterArgType
|
Example
Query
query userGroups(
$limit: Int,
$offset: Int,
$search: UserGroupSearchArgType,
$order: UserGroupOrderArgType,
$filter: UserGroupFilterArgType
) {
userGroups(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...UserGroupModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"search": UserGroupSearchArgType,
"order": UserGroupOrderArgType,
"filter": UserGroupFilterArgType
}
Response
{
"data": {
"userGroups": {
"totalCount": 987,
"data": [UserGroupModel]
}
}
}
userInvite
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query userInvite($id: ID!) {
userInvite(id: $id) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"userInvite": {
"id": 4,
"email": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"locale": "xyz789",
"data": JsonObject,
"status": "accepted",
"createdByUserId": "4",
"createdBy": UserModel,
"userTokenId": "4",
"acceptedByUserId": 4,
"tenantId": 4,
"roleKeys": ["xyz789"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
userInvites
Response
Returns a
UserInvitePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
UserInviteSearchArgType
|
|
order -
UserInviteOrderArgType
|
|
filter -
UserInviteFilterArgType
|
Example
Query
query userInvites(
$limit: Int,
$offset: Int,
$search: UserInviteSearchArgType,
$order: UserInviteOrderArgType,
$filter: UserInviteFilterArgType
) {
userInvites(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...UserInviteModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"search": UserInviteSearchArgType,
"order": UserInviteOrderArgType,
"filter": UserInviteFilterArgType
}
Response
{
"data": {
"userInvites": {
"totalCount": 987,
"data": [UserInviteModel]
}
}
}
userProfile
Response
Returns a
UserProfileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query userProfile($id: ID!) {
userProfile(id: $id) {
id
reference
email
firstName
lastName
locale
avatarUrl
timezone
phone
connectedProviders {
...UserConnectedProviderModelFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"userProfile": {
"id": "4",
"reference": "abc123",
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"avatarUrl": "abc123",
"timezone": "abc123",
"phone": "abc123",
"connectedProviders": [UserConnectedProviderModel]
}
}
}
userProfiles
Response
Returns a
UserProfilePageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
UserProfileSearchArgType
|
|
order -
UserProfileOrderArgType
|
|
filter -
UserFilterArgType
|
Example
Query
query userProfiles(
$limit: Int,
$offset: Int,
$search: UserProfileSearchArgType,
$order: UserProfileOrderArgType,
$filter: UserFilterArgType
) {
userProfiles(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...UserProfileModelFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"search": UserProfileSearchArgType,
"order": UserProfileOrderArgType,
"filter": UserFilterArgType
}
Response
{
"data": {
"userProfiles": {
"totalCount": 987,
"data": [UserProfileModel]
}
}
}
users
Response
Returns a
UserPageModel!
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
offset -
Int
|
|
search -
UserSearchArgType
|
|
order -
UserOrderArgType
|
|
filter -
UserFilterArgType
|
Example
Query
query users(
$limit: Int,
$offset: Int,
$search: UserSearchArgType,
$order: UserOrderArgType,
$filter: UserFilterArgType
) {
users(
limit: $limit,
offset: $offset,
search: $search,
order: $order,
filter: $filter
) {
totalCount
data {
...UserModelFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"search": UserSearchArgType,
"order": UserOrderArgType,
"filter": UserFilterArgType
}
Response
{
"data": {
"users": {"totalCount": 123, "data": [UserModel]}
}
}
Mutations
acceptUserInvite
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
acceptUserInvite -
AcceptUserInviteDto!
|
Example
Query
mutation acceptUserInvite($acceptUserInvite: AcceptUserInviteDto!) {
acceptUserInvite(acceptUserInvite: $acceptUserInvite) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"acceptUserInvite": AcceptUserInviteDto}
Response
{
"data": {
"acceptUserInvite": {
"id": 4,
"email": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"locale": "abc123",
"data": JsonObject,
"status": "accepted",
"createdByUserId": 4,
"createdBy": UserModel,
"userTokenId": 4,
"acceptedByUserId": 4,
"tenantId": 4,
"roleKeys": ["abc123"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
acceptUserInviteV2
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
data -
AcceptUserInviteV2Dto!
|
Example
Query
mutation acceptUserInviteV2($data: AcceptUserInviteV2Dto!) {
acceptUserInviteV2(data: $data) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"data": AcceptUserInviteV2Dto}
Response
{
"data": {
"acceptUserInviteV2": {
"id": 4,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"data": JsonObject,
"status": "accepted",
"createdByUserId": "4",
"createdBy": UserModel,
"userTokenId": 4,
"acceptedByUserId": 4,
"tenantId": "4",
"roleKeys": ["xyz789"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
addUsersToUserGroup
Example
Query
mutation addUsersToUserGroup(
$userGroupId: ID!,
$userIds: [ID!]!
) {
addUsersToUserGroup(
userGroupId: $userGroupId,
userIds: $userIds
)
}
Variables
{"userGroupId": "4", "userIds": [4]}
Response
{"data": {"addUsersToUserGroup": true}}
assignRolesToUser
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
userId -
ID!
|
|
roleKeys -
[String!]!
|
Example
Query
mutation assignRolesToUser(
$userId: ID!,
$roleKeys: [String!]!
) {
assignRolesToUser(
userId: $userId,
roleKeys: $roleKeys
)
}
Variables
{
"userId": "4",
"roleKeys": ["abc123"]
}
Response
{"data": {"assignRolesToUser": false}}
assignTagsToConversation
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
conversationId -
ID!
|
|
tags -
[String!]!
|
Example
Query
mutation assignTagsToConversation(
$conversationId: ID!,
$tags: [String!]!
) {
assignTagsToConversation(
conversationId: $conversationId,
tags: $tags
)
}
Variables
{"conversationId": 4, "tags": ["xyz789"]}
Response
{"data": {"assignTagsToConversation": true}}
buildQueryPlan
Response
Returns
[QueryPlanModel!]!
Arguments
| Name | Description |
|---|---|
entity -
String!
|
|
operation -
ResourceOperationEnum!
|
Example
Query
mutation buildQueryPlan(
$entity: String!,
$operation: ResourceOperationEnum!
) {
buildQueryPlan(
entity: $entity,
operation: $operation
) {
queryPlan
kind
userIdField
role
entity
operation
scope
tenantName
tenantId
}
}
Variables
{"entity": "abc123", "operation": "read"}
Response
{
"data": {
"buildQueryPlan": [
{
"queryPlan": JsonObject,
"kind": "abc123",
"userIdField": "abc123",
"role": "abc123",
"entity": "abc123",
"operation": "abc123",
"scope": "xyz789",
"tenantName": "abc123",
"tenantId": "xyz789"
}
]
}
}
cancelUserInvite
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation cancelUserInvite($id: ID!) {
cancelUserInvite(id: $id) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"cancelUserInvite": {
"id": 4,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "abc123",
"data": JsonObject,
"status": "accepted",
"createdByUserId": 4,
"createdBy": UserModel,
"userTokenId": "4",
"acceptedByUserId": "4",
"tenantId": 4,
"roleKeys": ["abc123"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
changeUserPassword
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UserPasswordUpdateDto!
|
Example
Query
mutation changeUserPassword(
$id: ID!,
$input: UserPasswordUpdateDto!
) {
changeUserPassword(
id: $id,
input: $input
)
}
Variables
{"id": 4, "input": UserPasswordUpdateDto}
Response
{"data": {"changeUserPassword": false}}
changeUserPasswordV2
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
data -
ChangeUserPasswordDto!
|
Example
Query
mutation changeUserPasswordV2($data: ChangeUserPasswordDto!) {
changeUserPasswordV2(data: $data)
}
Variables
{"data": ChangeUserPasswordDto}
Response
{"data": {"changeUserPasswordV2": true}}
createConversation
Response
Returns a
ConversationModel!
Arguments
| Name | Description |
|---|---|
conversation -
ConversationCreateDto!
|
Example
Query
mutation createConversation($conversation: ConversationCreateDto!) {
createConversation(conversation: $conversation) {
id
title
isGroup
ownerId
users {
...ConversationUserPageModelFragment
}
createdAt
updatedAt
tags {
...ConversationTagPageModelFragment
}
active
archived
}
}
Variables
{"conversation": ConversationCreateDto}
Response
{
"data": {
"createConversation": {
"id": "4",
"title": "xyz789",
"isGroup": true,
"ownerId": "abc123",
"users": ConversationUserPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"tags": ConversationTagPageModel,
"active": false,
"archived": true
}
}
}
createFileAssociation
Response
Returns a
FileAssociationModel!
Arguments
| Name | Description |
|---|---|
createFileAssociationDto -
FileAssociationCreateDto!
|
Example
Query
mutation createFileAssociation($createFileAssociationDto: FileAssociationCreateDto!) {
createFileAssociation(createFileAssociationDto: $createFileAssociationDto) {
id
entityReference
entityName
fileId
file {
...FileModelFragment
}
createdAt
updatedAt
}
}
Variables
{"createFileAssociationDto": FileAssociationCreateDto}
Response
{
"data": {
"createFileAssociation": {
"id": 4,
"entityReference": 4,
"entityName": "abc123",
"fileId": "4",
"file": FileModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
createFileAssociationV2
Response
Returns a
FileAssociationModel!
Arguments
| Name | Description |
|---|---|
data -
FileAssociationCreateDto!
|
Example
Query
mutation createFileAssociationV2($data: FileAssociationCreateDto!) {
createFileAssociationV2(data: $data) {
id
entityReference
entityName
fileId
file {
...FileModelFragment
}
createdAt
updatedAt
}
}
Variables
{"data": FileAssociationCreateDto}
Response
{
"data": {
"createFileAssociationV2": {
"id": 4,
"entityReference": "4",
"entityName": "abc123",
"fileId": "4",
"file": FileModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
createFileUpload
Response
Returns a
FileCreateUploadModel!
Arguments
| Name | Description |
|---|---|
createFileDto -
FileCreateDto!
|
Example
Query
mutation createFileUpload($createFileDto: FileCreateDto!) {
createFileUpload(createFileDto: $createFileDto) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
uploadUrl
formFields
}
}
Variables
{"createFileDto": FileCreateDto}
Response
{
"data": {
"createFileUpload": {
"id": 4,
"name": "abc123",
"status": "cancelled",
"createdByUserId": 4,
"fileCategoryId": "4",
"contentType": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"uploadUrl": "xyz789",
"formFields": JsonObject
}
}
}
createFileUploadV2
Response
Returns a
FileCreateUploadModel!
Arguments
| Name | Description |
|---|---|
data -
FileCreateV2Dto!
|
Example
Query
mutation createFileUploadV2($data: FileCreateV2Dto!) {
createFileUploadV2(data: $data) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
uploadUrl
formFields
}
}
Variables
{"data": FileCreateV2Dto}
Response
{
"data": {
"createFileUploadV2": {
"id": "4",
"name": "xyz789",
"status": "cancelled",
"createdByUserId": 4,
"fileCategoryId": "4",
"contentType": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": true,
"fileCategory": FileCategoryModel,
"uploadUrl": "xyz789",
"formFields": JsonObject
}
}
}
createMessage
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
message -
MessageCreateDto!
|
Example
Query
mutation createMessage($message: MessageCreateDto!) {
createMessage(message: $message)
}
Variables
{"message": MessageCreateDto}
Response
{"data": {"createMessage": false}}
createProjectEntity
Response
Returns a
ProjectEntityModel!
Arguments
| Name | Description |
|---|---|
projectEntity -
ProjectEntityDto!
|
Example
Query
mutation createProjectEntity($projectEntity: ProjectEntityDto!) {
createProjectEntity(projectEntity: $projectEntity) {
id
name
identifierField
isPublic
entityRelations {
...EntityRelationPageModelFragment
}
permissions {
...PermissionPageModelFragment
}
}
}
Variables
{"projectEntity": ProjectEntityDto}
Response
{
"data": {
"createProjectEntity": {
"id": 4,
"name": "abc123",
"identifierField": "abc123",
"isPublic": true,
"entityRelations": EntityRelationPageModel,
"permissions": PermissionPageModel
}
}
}
createTenant
Response
Returns a
TenantModel!
Arguments
| Name | Description |
|---|---|
tenant -
TenantCreateDto!
|
Example
Query
mutation createTenant($tenant: TenantCreateDto!) {
createTenant(tenant: $tenant) {
id
name
reference
isDefault
createdAt
updatedAt
users {
...UsersCountModelFragment
}
}
}
Variables
{"tenant": TenantCreateDto}
Response
{
"data": {
"createTenant": {
"id": 4,
"name": "xyz789",
"reference": "xyz789",
"isDefault": false,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"users": UsersCountModel
}
}
}
createTranslationKey
Response
Returns a
TranslationKeyModel!
Arguments
| Name | Description |
|---|---|
translationKey -
TranslationKeyCreateDto!
|
Example
Query
mutation createTranslationKey($translationKey: TranslationKeyCreateDto!) {
createTranslationKey(translationKey: $translationKey) {
id
key
translations {
...TranslationPageModelFragment
}
createdAt
updatedAt
}
}
Variables
{"translationKey": TranslationKeyCreateDto}
Response
{
"data": {
"createTranslationKey": {
"id": 4,
"key": "xyz789",
"translations": TranslationPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
createUser
Response
Returns a
UserModel!
Arguments
| Name | Description |
|---|---|
user -
UserCreateDto!
|
Example
Query
mutation createUser($user: UserCreateDto!) {
createUser(user: $user) {
id
email
reference
phone
firstName
lastName
locale
timezone
isOptedIn
synced
active
customData
avatarUrl
userGroups {
...UserGroupPageModelFragment
}
roles {
...RolePageModelFragment
}
tenantId
tenant {
...TenantModelFragment
}
twoFactorEnabled
createdAt
updatedAt
}
}
Variables
{"user": UserCreateDto}
Response
{
"data": {
"createUser": {
"id": 4,
"email": "abc123",
"reference": "xyz789",
"phone": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"locale": "xyz789",
"timezone": "xyz789",
"isOptedIn": false,
"synced": false,
"active": true,
"customData": JsonObject,
"avatarUrl": "xyz789",
"userGroups": UserGroupPageModel,
"roles": RolePageModel,
"tenantId": 4,
"tenant": TenantModel,
"twoFactorEnabled": true,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
createUserGroup
Response
Returns a
UserGroupModel!
Arguments
| Name | Description |
|---|---|
userGroup -
UserGroupCreateDto!
|
Example
Query
mutation createUserGroup($userGroup: UserGroupCreateDto!) {
createUserGroup(userGroup: $userGroup) {
id
type
name
reference
userGroupType {
...UserGroupTypeModelFragment
}
users {
...UserPageModelFragment
}
roles {
...RolePageModelFragment
}
}
}
Variables
{"userGroup": UserGroupCreateDto}
Response
{
"data": {
"createUserGroup": {
"id": 4,
"type": "abc123",
"name": "abc123",
"reference": "abc123",
"userGroupType": UserGroupTypeModel,
"users": UserPageModel,
"roles": RolePageModel
}
}
}
deleteConversation
deleteFileAssociations
Response
Returns
[String!]!
Arguments
| Name | Description |
|---|---|
filter -
FileAssociationBulkFilterArgType!
|
Example
Query
mutation deleteFileAssociations($filter: FileAssociationBulkFilterArgType!) {
deleteFileAssociations(filter: $filter)
}
Variables
{"filter": FileAssociationBulkFilterArgType}
Response
{
"data": {
"deleteFileAssociations": ["xyz789"]
}
}
deleteFiles
Response
Returns
[ID!]!
Arguments
| Name | Description |
|---|---|
filter -
DeleteFilterArgType
|
Example
Query
mutation deleteFiles($filter: DeleteFilterArgType) {
deleteFiles(filter: $filter)
}
Variables
{"filter": DeleteFilterArgType}
Response
{"data": {"deleteFiles": [4]}}
deleteProjectEntity
generateUserPhoneOtp
makeFilePrivate
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation makeFilePrivate($id: ID!) {
makeFilePrivate(id: $id) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"makeFilePrivate": {
"id": "4",
"name": "abc123",
"status": "cancelled",
"createdByUserId": "4",
"fileCategoryId": 4,
"contentType": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"url": "abc123",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
makeFilePublic
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation makeFilePublic($id: ID!) {
makeFilePublic(id: $id) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"makeFilePublic": {
"id": 4,
"name": "xyz789",
"status": "cancelled",
"createdByUserId": "4",
"fileCategoryId": 4,
"contentType": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"url": "abc123",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
markAllNotificationsAsRead
Response
Returns an
Int!
Example
Query
mutation markAllNotificationsAsRead {
markAllNotificationsAsRead
}
Response
{"data": {"markAllNotificationsAsRead": 123}}
markNotifications
Response
Returns
[NotificationModel!]!
Arguments
| Name | Description |
|---|---|
messageIds -
[String!]!
|
|
mark -
MarkNotificationsDto!
|
Example
Query
mutation markNotifications(
$messageIds: [String!]!,
$mark: MarkNotificationsDto!
) {
markNotifications(
messageIds: $messageIds,
mark: $mark
) {
id
createdAt
templateIdentifier
content
seen
read
email
providerId
title
icon
lastSeenDate
status
channel
}
}
Variables
{
"messageIds": ["xyz789"],
"mark": MarkNotificationsDto
}
Response
{
"data": {
"markNotifications": [
{
"id": "abc123",
"createdAt": "2007-12-03",
"templateIdentifier": "abc123",
"content": "abc123",
"seen": false,
"read": false,
"email": "xyz789",
"providerId": "abc123",
"title": "abc123",
"icon": "abc123",
"lastSeenDate": "xyz789",
"status": "sent",
"channel": "email"
}
]
}
}
notify
Response
Returns a
NotificationCreateModel!
Arguments
| Name | Description |
|---|---|
notification -
NotificationCreateDto!
|
Example
Query
mutation notify($notification: NotificationCreateDto!) {
notify(notification: $notification) {
usersNotified {
...NotificationCreateUserModelFragment
}
}
}
Variables
{"notification": NotificationCreateDto}
Response
{
"data": {
"notify": {
"usersNotified": NotificationCreateUserModel
}
}
}
removeUsersFromUserGroup
Example
Query
mutation removeUsersFromUserGroup(
$userGroupId: ID!,
$userIds: [ID!]!
) {
removeUsersFromUserGroup(
userGroupId: $userGroupId,
userIds: $userIds
)
}
Variables
{"userGroupId": 4, "userIds": ["4"]}
Response
{"data": {"removeUsersFromUserGroup": true}}
resendUserInvite
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation resendUserInvite($id: ID!) {
resendUserInvite(id: $id) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"resendUserInvite": {
"id": "4",
"email": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"locale": "xyz789",
"data": JsonObject,
"status": "accepted",
"createdByUserId": 4,
"createdBy": UserModel,
"userTokenId": 4,
"acceptedByUserId": 4,
"tenantId": 4,
"roleKeys": ["abc123"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
resendUserPhoneOtp
Response
Returns a
ResendUserPhoneOtpResponseModel!
Example
Query
mutation resendUserPhoneOtp(
$id: ID!,
$token: String!
) {
resendUserPhoneOtp(
id: $id,
token: $token
) {
isValid
retryIn
error
}
}
Variables
{
"id": "4",
"token": "xyz789"
}
Response
{
"data": {
"resendUserPhoneOtp": {
"isValid": true,
"retryIn": 123,
"error": "xyz789"
}
}
}
sendMail
Response
Returns a
MailCreateModel!
Arguments
| Name | Description |
|---|---|
mail -
MailCreateDto!
|
Example
Query
mutation sendMail($mail: MailCreateDto!) {
sendMail(mail: $mail) {
mailsSent {
...MailCreateUserModelFragment
}
}
}
Variables
{"mail": MailCreateDto}
Response
{"data": {"sendMail": {"mailsSent": MailCreateUserModel}}}
sendUserConfirmationMail
Example
Query
mutation sendUserConfirmationMail(
$userId: ID!,
$variantKey: String
) {
sendUserConfirmationMail(
userId: $userId,
variantKey: $variantKey
)
}
Variables
{
"userId": "4",
"variantKey": "abc123"
}
Response
{"data": {"sendUserConfirmationMail": true}}
sendUserInvites
Description
Create UserInvite and send email
Response
Returns a
CreateUserInvitesModel!
Arguments
| Name | Description |
|---|---|
userInvites -
UserInvitesCreateDto!
|
Example
Query
mutation sendUserInvites($userInvites: UserInvitesCreateDto!) {
sendUserInvites(userInvites: $userInvites) {
success {
...UserInviteModelFragment
}
errors {
...CreateUserInviteErrorModelFragment
}
}
}
Variables
{"userInvites": UserInvitesCreateDto}
Response
{
"data": {
"sendUserInvites": {
"success": [UserInviteModel],
"errors": [CreateUserInviteErrorModel]
}
}
}
sendUserInvitesV2
Description
Create UserInvite and send email
Response
Returns a
CreateUserInvitesModel!
Arguments
| Name | Description |
|---|---|
data -
UserInvitesCreateV2Dto!
|
Example
Query
mutation sendUserInvitesV2($data: UserInvitesCreateV2Dto!) {
sendUserInvitesV2(data: $data) {
success {
...UserInviteModelFragment
}
errors {
...CreateUserInviteErrorModelFragment
}
}
}
Variables
{"data": UserInvitesCreateV2Dto}
Response
{
"data": {
"sendUserInvitesV2": {
"success": [UserInviteModel],
"errors": [CreateUserInviteErrorModel]
}
}
}
sendUserResetPasswordMail
Example
Query
mutation sendUserResetPasswordMail(
$userId: ID!,
$variantKey: String
) {
sendUserResetPasswordMail(
userId: $userId,
variantKey: $variantKey
)
}
Variables
{
"userId": "4",
"variantKey": "xyz789"
}
Response
{"data": {"sendUserResetPasswordMail": true}}
unassignRolesFromUser
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
userId -
ID!
|
|
roleKeys -
[String!]!
|
Example
Query
mutation unassignRolesFromUser(
$userId: ID!,
$roleKeys: [String!]!
) {
unassignRolesFromUser(
userId: $userId,
roleKeys: $roleKeys
)
}
Variables
{
"userId": "4",
"roleKeys": ["xyz789"]
}
Response
{"data": {"unassignRolesFromUser": true}}
unassignTagsFromConversation
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
conversationId -
ID!
|
|
tags -
[String!]!
|
Example
Query
mutation unassignTagsFromConversation(
$conversationId: ID!,
$tags: [String!]!
) {
unassignTagsFromConversation(
conversationId: $conversationId,
tags: $tags
)
}
Variables
{
"conversationId": "4",
"tags": ["abc123"]
}
Response
{"data": {"unassignTagsFromConversation": false}}
updateFile
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
updateFileDto -
FileUpdateDto!
|
Example
Query
mutation updateFile(
$id: ID!,
$updateFileDto: FileUpdateDto!
) {
updateFile(
id: $id,
updateFileDto: $updateFileDto
) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{
"id": "4",
"updateFileDto": FileUpdateDto
}
Response
{
"data": {
"updateFile": {
"id": 4,
"name": "abc123",
"status": "cancelled",
"createdByUserId": 4,
"fileCategoryId": "4",
"contentType": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"url": "xyz789",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
updateFileStatus
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
status -
FileStatusEnum!
|
Example
Query
mutation updateFileStatus(
$id: ID!,
$status: FileStatusEnum!
) {
updateFileStatus(
id: $id,
status: $status
) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{"id": 4, "status": "cancelled"}
Response
{
"data": {
"updateFileStatus": {
"id": 4,
"name": "abc123",
"status": "cancelled",
"createdByUserId": 4,
"fileCategoryId": 4,
"contentType": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": true,
"fileCategory": FileCategoryModel,
"url": "xyz789",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
updateFileV2
Response
Returns a
FileModel!
Arguments
| Name | Description |
|---|---|
data -
FileUpdateV2Dto!
|
Example
Query
mutation updateFileV2($data: FileUpdateV2Dto!) {
updateFileV2(data: $data) {
id
name
status
createdByUserId
fileCategoryId
contentType
createdAt
updatedAt
isPublic
fileCategory {
...FileCategoryModelFragment
}
url
fileAssociations {
...FileAssociationPageModelFragment
}
createdByUser {
...UserModelFragment
}
}
}
Variables
{"data": FileUpdateV2Dto}
Response
{
"data": {
"updateFileV2": {
"id": 4,
"name": "xyz789",
"status": "cancelled",
"createdByUserId": "4",
"fileCategoryId": "4",
"contentType": "xyz789",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": true,
"fileCategory": FileCategoryModel,
"url": "abc123",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
}
}
updateNotificationPreference
Response
Returns a
NotificationPreferenceModel!
Arguments
| Name | Description |
|---|---|
id -
String!
|
|
preference -
UpdateNotificationPreferenceDto!
|
Example
Query
mutation updateNotificationPreference(
$id: String!,
$preference: UpdateNotificationPreferenceDto!
) {
updateNotificationPreference(
id: $id,
preference: $preference
) {
name
id
key
enabled
channelPreferences {
...ChannelPreferencePageModelFragment
}
}
}
Variables
{
"id": "abc123",
"preference": UpdateNotificationPreferenceDto
}
Response
{
"data": {
"updateNotificationPreference": {
"name": "xyz789",
"id": "abc123",
"key": "abc123",
"enabled": true,
"channelPreferences": ChannelPreferencePageModel
}
}
}
updateProfile
Response
Returns a
UserProfileModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
user -
UserUpdateProfileDto!
|
Example
Query
mutation updateProfile(
$id: ID!,
$user: UserUpdateProfileDto!
) {
updateProfile(
id: $id,
user: $user
) {
id
reference
email
firstName
lastName
locale
avatarUrl
timezone
phone
connectedProviders {
...UserConnectedProviderModelFragment
}
}
}
Variables
{
"id": "4",
"user": UserUpdateProfileDto
}
Response
{
"data": {
"updateProfile": {
"id": 4,
"reference": "abc123",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"avatarUrl": "xyz789",
"timezone": "xyz789",
"phone": "abc123",
"connectedProviders": [UserConnectedProviderModel]
}
}
}
updateProjectEntity
Response
Returns a
ProjectEntityModel!
Arguments
| Name | Description |
|---|---|
projectEntity -
ProjectEntityDto!
|
Example
Query
mutation updateProjectEntity($projectEntity: ProjectEntityDto!) {
updateProjectEntity(projectEntity: $projectEntity) {
id
name
identifierField
isPublic
entityRelations {
...EntityRelationPageModelFragment
}
permissions {
...PermissionPageModelFragment
}
}
}
Variables
{"projectEntity": ProjectEntityDto}
Response
{
"data": {
"updateProjectEntity": {
"id": 4,
"name": "abc123",
"identifierField": "xyz789",
"isPublic": true,
"entityRelations": EntityRelationPageModel,
"permissions": PermissionPageModel
}
}
}
updateProjectPermissions
Response
Returns a
RoleModel!
Arguments
| Name | Description |
|---|---|
roleId -
ID!
|
|
projectPermissions -
ProjectPermissionsDto!
|
Example
Query
mutation updateProjectPermissions(
$roleId: ID!,
$projectPermissions: ProjectPermissionsDto!
) {
updateProjectPermissions(
roleId: $roleId,
projectPermissions: $projectPermissions
) {
id
key
name
projectEntityId
userIdField
reference
description
isSystemManaged
inviteRoleKeys
users {
...UsersCountModelFragment
}
userGroups {
...UserGroupPageModelFragment
}
}
}
Variables
{
"roleId": "4",
"projectPermissions": ProjectPermissionsDto
}
Response
{
"data": {
"updateProjectPermissions": {
"id": "4",
"key": "xyz789",
"name": "xyz789",
"projectEntityId": 4,
"userIdField": "xyz789",
"reference": "abc123",
"description": "xyz789",
"isSystemManaged": false,
"inviteRoleKeys": ["xyz789"],
"users": UsersCountModel,
"userGroups": UserGroupPageModel
}
}
}
updateTenant
Response
Returns a
TenantModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
tenant -
TenantUpdateDto!
|
Example
Query
mutation updateTenant(
$id: ID!,
$tenant: TenantUpdateDto!
) {
updateTenant(
id: $id,
tenant: $tenant
) {
id
name
reference
isDefault
createdAt
updatedAt
users {
...UsersCountModelFragment
}
}
}
Variables
{
"id": "4",
"tenant": TenantUpdateDto
}
Response
{
"data": {
"updateTenant": {
"id": 4,
"name": "xyz789",
"reference": "xyz789",
"isDefault": true,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"users": UsersCountModel
}
}
}
updateTranslationKey
Response
Returns a
TranslationKeyModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
translationKey -
TranslationKeyUpdateDto!
|
Example
Query
mutation updateTranslationKey(
$id: ID!,
$translationKey: TranslationKeyUpdateDto!
) {
updateTranslationKey(
id: $id,
translationKey: $translationKey
) {
id
key
translations {
...TranslationPageModelFragment
}
createdAt
updatedAt
}
}
Variables
{"id": 4, "translationKey": TranslationKeyUpdateDto}
Response
{
"data": {
"updateTranslationKey": {
"id": "4",
"key": "abc123",
"translations": TranslationPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
updateUser
Response
Returns a
UserModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
user -
UserUpdateDto!
|
Example
Query
mutation updateUser(
$id: ID!,
$user: UserUpdateDto!
) {
updateUser(
id: $id,
user: $user
) {
id
email
reference
phone
firstName
lastName
locale
timezone
isOptedIn
synced
active
customData
avatarUrl
userGroups {
...UserGroupPageModelFragment
}
roles {
...RolePageModelFragment
}
tenantId
tenant {
...TenantModelFragment
}
twoFactorEnabled
createdAt
updatedAt
}
}
Variables
{"id": 4, "user": UserUpdateDto}
Response
{
"data": {
"updateUser": {
"id": 4,
"email": "xyz789",
"reference": "xyz789",
"phone": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"timezone": "abc123",
"isOptedIn": true,
"synced": false,
"active": true,
"customData": JsonObject,
"avatarUrl": "abc123",
"userGroups": UserGroupPageModel,
"roles": RolePageModel,
"tenantId": "4",
"tenant": TenantModel,
"twoFactorEnabled": false,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
}
}
updateUserGroup
Response
Returns a
UserGroupModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
userGroup -
UserGroupUpdateDto!
|
Example
Query
mutation updateUserGroup(
$id: ID!,
$userGroup: UserGroupUpdateDto!
) {
updateUserGroup(
id: $id,
userGroup: $userGroup
) {
id
type
name
reference
userGroupType {
...UserGroupTypeModelFragment
}
users {
...UserPageModelFragment
}
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": 4, "userGroup": UserGroupUpdateDto}
Response
{
"data": {
"updateUserGroup": {
"id": 4,
"type": "xyz789",
"name": "abc123",
"reference": "abc123",
"userGroupType": UserGroupTypeModel,
"users": UserPageModel,
"roles": RolePageModel
}
}
}
updateUserInvite
Response
Returns a
UserInviteModel!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
userInvite -
UserInviteUpdateDto!
|
Example
Query
mutation updateUserInvite(
$id: ID!,
$userInvite: UserInviteUpdateDto!
) {
updateUserInvite(
id: $id,
userInvite: $userInvite
) {
id
email
firstName
lastName
locale
data
status
createdByUserId
createdBy {
...UserModelFragment
}
userTokenId
acceptedByUserId
tenantId
roleKeys
acceptedBy {
...UserModelFragment
}
createdAt
updatedAt
statusUpdatedAt
roles {
...RolePageModelFragment
}
}
}
Variables
{"id": 4, "userInvite": UserInviteUpdateDto}
Response
{
"data": {
"updateUserInvite": {
"id": "4",
"email": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"locale": "abc123",
"data": JsonObject,
"status": "accepted",
"createdByUserId": "4",
"createdBy": UserModel,
"userTokenId": "4",
"acceptedByUserId": 4,
"tenantId": "4",
"roleKeys": ["xyz789"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
}
}
upsertTranslationKeys
Response
Returns
[TranslationKeyModel!]!
Arguments
| Name | Description |
|---|---|
translationKeys -
[TranslationKeyCreateDto!]!
|
Example
Query
mutation upsertTranslationKeys($translationKeys: [TranslationKeyCreateDto!]!) {
upsertTranslationKeys(translationKeys: $translationKeys) {
id
key
translations {
...TranslationPageModelFragment
}
createdAt
updatedAt
}
}
Variables
{"translationKeys": [TranslationKeyCreateDto]}
Response
{
"data": {
"upsertTranslationKeys": [
{
"id": 4,
"key": "abc123",
"translations": TranslationPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
]
}
}
verifyPassword
Example
Query
mutation verifyPassword(
$userId: ID!,
$password: String!
) {
verifyPassword(
userId: $userId,
password: $password
)
}
Variables
{"userId": 4, "password": "xyz789"}
Response
{"data": {"verifyPassword": false}}
verifyUserPhoneOtp
Response
Returns a
VerifyUserPhoneOtpResponseModel!
Example
Query
mutation verifyUserPhoneOtp(
$id: ID!,
$token: String!
) {
verifyUserPhoneOtp(
id: $id,
token: $token
) {
isValid
totalTryRemain
totalTry
retryIn
error
}
}
Variables
{"id": 4, "token": "xyz789"}
Response
{
"data": {
"verifyUserPhoneOtp": {
"isValid": false,
"totalTryRemain": 987,
"totalTry": 123,
"retryIn": 987,
"error": "abc123"
}
}
}
Types
AcceptUserInviteDto
Fields
| Input Field | Description |
|---|---|
token -
String!
|
Example
{"token": "xyz789"}
AcceptUserInviteV2Dto
Fields
| Input Field | Description |
|---|---|
token -
String!
|
Example
{"token": "abc123"}
Boolean
Description
The Boolean scalar type represents true or false.
BooleanFilterArgType
ChangeUserPasswordDto
ChannelPreferenceModel
ChannelPreferencePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[ChannelPreferenceModel!]!
|
Example
{"totalCount": 123, "data": [ChannelPreferenceModel]}
CheckUserInviteTokenModel
ConversationCreateDto
ConversationFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
messageId -
IdFilterArgType
|
|
conversationUserId -
IdFilterArgType
|
|
ownerId -
IdFilterArgType
|
|
memberId -
MemberIdFilterArgType
|
|
isGroup -
BooleanFilterArgType
|
Example
{
"id": IdFilterArgType,
"messageId": IdFilterArgType,
"conversationUserId": IdFilterArgType,
"ownerId": IdFilterArgType,
"memberId": MemberIdFilterArgType,
"isGroup": BooleanFilterArgType
}
ConversationModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
title -
String!
|
|
isGroup -
Boolean!
|
|
ownerId -
String!
|
|
users -
ConversationUserPageModel!
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
tags -
ConversationTagPageModel!
|
|
active -
Boolean!
|
|
archived -
Boolean!
|
Example
{
"id": 4,
"title": "abc123",
"isGroup": true,
"ownerId": "abc123",
"users": ConversationUserPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"tags": ConversationTagPageModel,
"active": true,
"archived": true
}
ConversationOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
ConversationOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
ConversationOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
ConversationPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Float!
|
|
data -
[ConversationModel!]!
|
Example
{"totalCount": 123.45, "data": [ConversationModel]}
ConversationSearchArgType
ConversationTagModel
ConversationTagPageModel
Fields
| Field Name | Description |
|---|---|
data -
[ConversationTagModel!]!
|
|
totalCount -
Float!
|
Example
{"data": [ConversationTagModel], "totalCount": 987.65}
ConversationUserModel
ConversationUserPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Float!
|
|
data -
[ConversationUserModel!]!
|
Example
{"totalCount": 123.45, "data": [ConversationUserModel]}
CreateUserInviteErrorModel
CreateUserInvitesModel
Fields
| Field Name | Description |
|---|---|
success -
[UserInviteModel!]
|
|
errors -
[CreateUserInviteErrorModel!]
|
Example
{
"success": [UserInviteModel],
"errors": [CreateUserInviteErrorModel]
}
Date
Description
Date custom scalar type
Example
"2007-12-03"
DateFilterArgType
Example
{
"moreThan": "2007-12-03",
"lessThan": "2007-12-03",
"moreThanEqual": "2007-12-03",
"lessThanEqual": "2007-12-03",
"equalTo": "2007-12-03",
"notEqualTo": "2007-12-03"
}
DeleteArgType
DeleteFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
DeleteArgType
|
Example
{"id": DeleteArgType}
EntityNameFilterArgType
Fields
| Input Field | Description |
|---|---|
equalTo -
String
|
Example
{"equalTo": "xyz789"}
EntityRelationDto
Example
{
"id": 4,
"leftEntityId": 4,
"rightEntityId": 4,
"relationField": "xyz789",
"leftRelationField": "xyz789",
"joinRelationTable": "abc123",
"rightRelationField": "abc123",
"oneToOneParentEntityId": "4",
"cardinality": "xyz789"
}
EntityRelationModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
leftEntityId -
ID!
|
|
rightEntityId -
ID!
|
|
leftEntity -
String!
|
|
rightEntity -
String!
|
|
joinRelationTable -
String
|
|
relationField -
String
|
|
leftRelationField -
String
|
|
rightRelationField -
String
|
|
oneToOneParentEntityId -
ID
|
|
oneToOneParentEntity -
String
|
|
cardinality -
String!
|
Example
{
"id": 4,
"leftEntityId": 4,
"rightEntityId": "4",
"leftEntity": "abc123",
"rightEntity": "xyz789",
"joinRelationTable": "abc123",
"relationField": "xyz789",
"leftRelationField": "xyz789",
"rightRelationField": "abc123",
"oneToOneParentEntityId": 4,
"oneToOneParentEntity": "xyz789",
"cardinality": "xyz789"
}
EntityRelationPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[EntityRelationModel!]!
|
Example
{"totalCount": 123, "data": [EntityRelationModel]}
FileAssociationBulkFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdBulkFilterArgType
|
|
fileId -
IdBulkFilterArgType
|
Example
{
"id": IdBulkFilterArgType,
"fileId": IdBulkFilterArgType
}
FileAssociationCreateDto
FileAssociationFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
entityReference -
StringFilterArgType
|
|
entityName -
StringFilterArgType
|
|
fileId -
IdFilterArgType
|
Example
{
"id": IdFilterArgType,
"entityReference": StringFilterArgType,
"entityName": StringFilterArgType,
"fileId": IdFilterArgType
}
FileAssociationModel
Example
{
"id": 4,
"entityReference": 4,
"entityName": "abc123",
"fileId": 4,
"file": FileModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
FileAssociationOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
FileAssociationOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
FileAssociationOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
FileAssociationPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[FileAssociationModel!]!
|
Example
{"totalCount": 987, "data": [FileAssociationModel]}
FileAssociationSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
FileAssociationSearchKeyEnum!
|
|
value -
String!
|
Example
{
"key": "entityReference",
"value": "xyz789"
}
FileAssociationSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"entityReference"
FileCategoryContentGroupFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
key -
StringFilterArgType
|
|
fileCategoryId -
IdFilterArgType
|
|
name -
StringFilterArgType
|
Example
{
"id": IdFilterArgType,
"key": StringFilterArgType,
"fileCategoryId": IdFilterArgType,
"name": StringFilterArgType
}
FileCategoryContentGroupModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
key -
String!
|
|
name -
String!
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
fileCategories -
FileCategoryPageModel!
|
|
Arguments
|
|
fileCategoryContentTypes -
FileCategoryContentTypePageModel!
|
|
Arguments
|
|
Example
{
"id": 4,
"key": "abc123",
"name": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"fileCategories": FileCategoryPageModel,
"fileCategoryContentTypes": FileCategoryContentTypePageModel
}
FileCategoryContentGroupOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
FileCategoryContentGroupOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
FileCategoryContentGroupOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
FileCategoryContentGroupPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[FileCategoryContentGroupModel!]!
|
Example
{
"totalCount": 987,
"data": [FileCategoryContentGroupModel]
}
FileCategoryContentGroupSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
FileCategoryContentGroupSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "key", "value": "abc123"}
FileCategoryContentGroupSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"key"
FileCategoryContentTypeFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
key -
StringFilterArgType
|
|
name -
StringFilterArgType
|
|
fileCategoryContentGroup -
StringFilterArgType
|
Example
{
"id": IdFilterArgType,
"key": StringFilterArgType,
"name": StringFilterArgType,
"fileCategoryContentGroup": StringFilterArgType
}
FileCategoryContentTypeModel
Example
{
"id": 4,
"key": "xyz789",
"name": "abc123",
"fileCategoryContentGroupId": 4,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"fileCategoryContentGroup": FileCategoryContentGroupModel
}
FileCategoryContentTypeOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
FileCategoryContentTypeOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
FileCategoryContentTypeOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
FileCategoryContentTypePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[FileCategoryContentTypeModel!]!
|
Example
{
"totalCount": 987,
"data": [FileCategoryContentTypeModel]
}
FileCategoryContentTypeSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
FileCategoryContentTypeSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "key", "value": "xyz789"}
FileCategoryContentTypeSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"key"
FileCategoryFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
name -
StringFilterArgType
|
|
key -
StringFilterArgType
|
|
maxSize -
NumberFilterArgType
|
Example
{
"id": IdFilterArgType,
"name": StringFilterArgType,
"key": StringFilterArgType,
"maxSize": NumberFilterArgType
}
FileCategoryModel
Example
{
"id": "4",
"name": "xyz789",
"key": "xyz789",
"maxSize": 987.65,
"isPublicByDefault": false,
"fileCategoryContentGroups": FileCategoryContentGroupPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
FileCategoryOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
FileCategoryOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
FileCategoryOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
FileCategoryPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[FileCategoryModel!]!
|
Example
{"totalCount": 987, "data": [FileCategoryModel]}
FileCategorySearchArgType
Fields
| Input Field | Description |
|---|---|
key -
FileCategorySearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "name", "value": "xyz789"}
FileCategorySearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"name"
FileCreateDto
FileCreateUploadModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
name -
String!
|
|
status -
FileStatusEnum!
|
|
createdByUserId -
ID!
|
|
fileCategoryId -
ID!
|
|
contentType -
String!
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
isPublic -
Boolean!
|
|
fileCategory -
FileCategoryModel!
|
|
uploadUrl -
String!
|
|
formFields -
JsonObject!
|
Example
{
"id": 4,
"name": "abc123",
"status": "cancelled",
"createdByUserId": "4",
"fileCategoryId": "4",
"contentType": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": false,
"fileCategory": FileCategoryModel,
"uploadUrl": "xyz789",
"formFields": JsonObject
}
FileCreateV2Dto
FileFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
name -
StringFilterArgType
|
|
status -
StatusFilterArgType
|
|
contentType -
StringFilterArgType
|
|
entityName -
EntityNameFilterArgType
|
|
entityReferences -
StringFilterArgType
|
|
fileCategory -
StringFilterArgType
|
|
createdByUserId -
IdFilterArgType
|
|
createdAt -
DateFilterArgType
|
|
isPublic -
BooleanFilterArgType
|
Example
{
"id": IdFilterArgType,
"name": StringFilterArgType,
"status": StatusFilterArgType,
"contentType": StringFilterArgType,
"entityName": EntityNameFilterArgType,
"entityReferences": StringFilterArgType,
"fileCategory": StringFilterArgType,
"createdByUserId": IdFilterArgType,
"createdAt": DateFilterArgType,
"isPublic": BooleanFilterArgType
}
FileModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
name -
String!
|
|
status -
FileStatusEnum!
|
|
createdByUserId -
ID!
|
|
fileCategoryId -
ID!
|
|
contentType -
String!
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
isPublic -
Boolean!
|
|
fileCategory -
FileCategoryModel!
|
|
url -
String
|
|
fileAssociations -
FileAssociationPageModel!
|
|
Arguments
|
|
createdByUser -
UserModel
|
|
Example
{
"id": "4",
"name": "xyz789",
"status": "cancelled",
"createdByUserId": 4,
"fileCategoryId": 4,
"contentType": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"isPublic": true,
"fileCategory": FileCategoryModel,
"url": "abc123",
"fileAssociations": FileAssociationPageModel,
"createdByUser": UserModel
}
FileOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
FileOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
FileOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
FilePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[FileModel!]!
|
Example
{"totalCount": 123, "data": [FileModel]}
FileSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
FileSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "name", "value": "abc123"}
FileSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"name"
FileStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"cancelled"
FileUpdateDto
Fields
| Input Field | Description |
|---|---|
name -
String
|
Example
{"name": "abc123"}
FileUpdateV2Dto
Fields
| Input Field | Description |
|---|---|
name -
String
|
|
fileId -
String!
|
|
status -
FileStatusEnum
|
Example
{
"name": "xyz789",
"fileId": "xyz789",
"status": "cancelled"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
123.45
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
IdBulkFilterArgType
IdFilterArgType
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JsonObject
Description
JSONObject custom scalar type
Example
JsonObject
MailCreateDto
Fields
| Input Field | Description |
|---|---|
key -
String!
|
|
locale -
String!
|
|
emails -
[String!]!
|
|
data -
[NotificationTemplateVariableDto!]
|
Example
{
"key": "abc123",
"locale": "xyz789",
"emails": ["xyz789"],
"data": [NotificationTemplateVariableDto]
}
MailCreateModel
Fields
| Field Name | Description |
|---|---|
mailsSent -
MailCreateUserModel!
|
Example
{"mailsSent": MailCreateUserModel}
MailCreateUserModel
Fields
| Field Name | Description |
|---|---|
count -
Int!
|
Example
{"count": 123}
MarkNotificationsDto
MemberIdFilterArgType
Fields
| Input Field | Description |
|---|---|
equalTo -
ID
|
Example
{"equalTo": "4"}
MessageCreateDto
MessageFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
body -
StringFilterArgType
|
|
conversationId -
IdFilterArgType
|
|
messageStatusId -
IdFilterArgType
|
|
conversationUserId -
IdFilterArgType
|
|
fileId -
IdFilterArgType
|
Example
{
"id": IdFilterArgType,
"body": StringFilterArgType,
"conversationId": IdFilterArgType,
"messageStatusId": IdFilterArgType,
"conversationUserId": IdFilterArgType,
"fileId": IdFilterArgType
}
MessageModel
Example
{
"id": 4,
"body": "abc123",
"conversationId": "xyz789",
"messageStatusId": "abc123",
"fileId": "abc123",
"authorId": "abc123",
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"deletedAt": "2007-12-03",
"file": FileModel
}
MessageOrderArgType
MessagePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Float!
|
|
data -
[MessageModel!]!
|
Example
{"totalCount": 123.45, "data": [MessageModel]}
MessageSearchArgType
NotificationChannelEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"email"
NotificationCreateDto
Fields
| Input Field | Description |
|---|---|
key -
String!
|
|
recipients -
NotificationRecipientDto!
|
|
data -
[NotificationTemplateVariableDto!]
|
Example
{
"key": "xyz789",
"recipients": NotificationRecipientDto,
"data": [NotificationTemplateVariableDto]
}
NotificationCreateModel
Fields
| Field Name | Description |
|---|---|
usersNotified -
NotificationCreateUserModel!
|
Example
{"usersNotified": NotificationCreateUserModel}
NotificationCreateUserModel
Fields
| Field Name | Description |
|---|---|
count -
Int!
|
Example
{"count": 987}
NotificationModel
Example
{
"id": "xyz789",
"createdAt": "2007-12-03",
"templateIdentifier": "xyz789",
"content": "xyz789",
"seen": true,
"read": false,
"email": "abc123",
"providerId": "abc123",
"title": "xyz789",
"icon": "xyz789",
"lastSeenDate": "xyz789",
"status": "sent",
"channel": "email"
}
NotificationPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[NotificationModel!]!
|
Example
{"totalCount": 987, "data": [NotificationModel]}
NotificationPreferenceModel
Fields
| Field Name | Description |
|---|---|
name -
String!
|
|
id -
String!
|
|
key -
String!
|
|
enabled -
Boolean!
|
|
channelPreferences -
ChannelPreferencePageModel!
|
Example
{
"name": "abc123",
"id": "xyz789",
"key": "abc123",
"enabled": false,
"channelPreferences": ChannelPreferencePageModel
}
NotificationRecipientDto
Fields
| Input Field | Description |
|---|---|
userIds -
[String!]
|
|
userGroups -
NotificationUserGroupDto
|
|
excludedUserIds -
[String!]
|
|
allUsers -
Boolean
|
|
tenantIds -
[String!]
|
Example
{
"userIds": ["abc123"],
"userGroups": NotificationUserGroupDto,
"excludedUserIds": ["xyz789"],
"allUsers": false,
"tenantIds": ["abc123"]
}
NotificationStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"sent"
NotificationTemplateVariableDto
NotificationUserGroupDto
Fields
| Input Field | Description |
|---|---|
operator -
NotificationUserGroupOperatorEnum!
|
|
userGroupIds -
[String!]
|
Example
{
"operator": "AND",
"userGroupIds": ["abc123"]
}
NotificationUserGroupOperatorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
NumberFilterArgType
Example
{
"equalTo": 123.45,
"notEqualTo": 123.45,
"moreThan": 123.45,
"lessThan": 987.65,
"moreThanEqual": 987.65,
"lessThanEqual": 123.45,
"valueNotIn": [987.65],
"valueIn": [987.65]
}
OrderEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
PermissionFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
key -
StringFilterArgType
|
|
resolverMapping -
StringFilterArgType
|
|
scope -
StringFilterArgType
|
|
roleId -
IdFilterArgType
|
|
type -
StringFilterArgType
|
Example
{
"id": IdFilterArgType,
"key": StringFilterArgType,
"resolverMapping": StringFilterArgType,
"scope": StringFilterArgType,
"roleId": IdFilterArgType,
"type": StringFilterArgType
}
PermissionModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
key -
String!
|
|
operation -
String!
|
|
platformEntity -
String
|
|
projectEntityId -
ID
|
|
type -
PermissionTypeEnum!
|
|
name -
String!
|
|
scope -
PermissionScopeEnum!
|
|
roleId -
ID!
|
|
role -
RoleModel!
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
Example
{
"id": 4,
"key": "abc123",
"operation": "xyz789",
"platformEntity": "xyz789",
"projectEntityId": "4",
"type": "platform",
"name": "xyz789",
"scope": "own",
"roleId": "4",
"role": RoleModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
PermissionOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
PermissionOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
PermissionOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
PermissionPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[PermissionModel!]!
|
Example
{"totalCount": 987, "data": [PermissionModel]}
PermissionScopeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"own"
PermissionSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
PermissionSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "key", "value": "abc123"}
PermissionSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"key"
PermissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"platform"
ProjectEntityDto
Example
{
"id": "4",
"name": "abc123",
"identifierField": "xyz789",
"isTenantEntity": false,
"isPublic": false,
"entityRelations": [EntityRelationDto]
}
ProjectEntityFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
Example
{"id": IdFilterArgType}
ProjectEntityModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
name -
String!
|
|
identifierField -
String!
|
|
isPublic -
Boolean!
|
|
entityRelations -
EntityRelationPageModel!
|
|
permissions -
PermissionPageModel!
|
Example
{
"id": "4",
"name": "abc123",
"identifierField": "xyz789",
"isPublic": true,
"entityRelations": EntityRelationPageModel,
"permissions": PermissionPageModel
}
ProjectEntityOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
ProjectEntityOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
ProjectEntityOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"createdAt"
ProjectEntityPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[ProjectEntityModel!]!
|
Example
{"totalCount": 987, "data": [ProjectEntityModel]}
ProjectEntityPathDto
ProjectPermissionsDto
Fields
| Input Field | Description |
|---|---|
projectEntityId -
ID!
|
|
userIdField -
String
|
|
permissionAssignments -
[RolePermissionAssignDto!]!
|
|
projectEntityPaths -
[ProjectEntityPathDto!]!
|
Example
{
"projectEntityId": "4",
"userIdField": "xyz789",
"permissionAssignments": [RolePermissionAssignDto],
"projectEntityPaths": [ProjectEntityPathDto]
}
QueryPlanModel
Example
{
"queryPlan": JsonObject,
"kind": "xyz789",
"userIdField": "xyz789",
"role": "abc123",
"entity": "abc123",
"operation": "abc123",
"scope": "abc123",
"tenantName": "xyz789",
"tenantId": "abc123"
}
ResendUserPhoneOtpResponseModel
ResourceOperationEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"read"
RoleFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
key -
StringFilterArgType
|
|
name -
StringFilterArgType
|
|
description -
StringFilterArgType
|
|
isSystemManaged -
BooleanFilterArgType
|
|
invite -
BooleanFilterArgType
|
|
userId -
IdFilterArgType
|
|
userGroupId -
IdFilterArgType
|
|
permissionId -
IdFilterArgType
|
Example
{
"id": IdFilterArgType,
"key": StringFilterArgType,
"name": StringFilterArgType,
"description": StringFilterArgType,
"isSystemManaged": BooleanFilterArgType,
"invite": BooleanFilterArgType,
"userId": IdFilterArgType,
"userGroupId": IdFilterArgType,
"permissionId": IdFilterArgType
}
RoleModel
Example
{
"id": 4,
"key": "xyz789",
"name": "xyz789",
"projectEntityId": "4",
"userIdField": "abc123",
"reference": "xyz789",
"description": "abc123",
"isSystemManaged": true,
"inviteRoleKeys": ["abc123"],
"users": UsersCountModel,
"userGroups": UserGroupPageModel
}
RoleOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
RoleOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
RoleOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
RolePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[RoleModel!]!
|
Example
{"totalCount": 123, "data": [RoleModel]}
RolePermissionAssignDto
Fields
| Input Field | Description |
|---|---|
id -
ID
|
|
key -
String
|
|
platformEntity -
ID
|
|
projectEntityId -
String
|
|
operation -
ResourceOperationEnum
|
|
type -
PermissionTypeEnum
|
|
scope -
PermissionScopeEnum
|
Example
{
"id": 4,
"key": "abc123",
"platformEntity": "4",
"projectEntityId": "xyz789",
"operation": "read",
"type": "platform",
"scope": "own"
}
RoleSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
RoleSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "key", "value": "xyz789"}
RoleSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"key"
StatusFilterArgType
Fields
| Input Field | Description |
|---|---|
equalTo -
FileStatusEnum
|
|
notEqualTo -
FileStatusEnum
|
|
valueNotIn -
[FileStatusEnum!]
|
|
valueIn -
[FileStatusEnum!]
|
Example
{
"equalTo": "cancelled",
"notEqualTo": "cancelled",
"valueNotIn": ["cancelled"],
"valueIn": ["cancelled"]
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StringFilterArgType
TenantCreateDto
TenantFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
reference -
StringFilterArgType
|
Example
{
"id": IdFilterArgType,
"reference": StringFilterArgType
}
TenantModel
Example
{
"id": 4,
"name": "xyz789",
"reference": "xyz789",
"isDefault": false,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"users": UsersCountModel
}
TenantOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
TenantOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
TenantOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"createdAt"
TenantPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[TenantModel!]!
|
Example
{"totalCount": 123, "data": [TenantModel]}
TenantUpdateDto
TranslationFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
translationKeyId -
IdFilterArgType
|
|
locale -
StringFilterArgType
|
Example
{
"id": IdFilterArgType,
"translationKeyId": IdFilterArgType,
"locale": StringFilterArgType
}
TranslationKeyCreateDto
Fields
| Input Field | Description |
|---|---|
key -
String!
|
|
translations -
[TranslationUpsertDto!]
|
Example
{
"key": "xyz789",
"translations": [TranslationUpsertDto]
}
TranslationKeyFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
key -
StringFilterArgType
|
|
locale -
StringFilterArgType
|
|
translated -
BooleanFilterArgType
|
Example
{
"id": IdFilterArgType,
"key": StringFilterArgType,
"locale": StringFilterArgType,
"translated": BooleanFilterArgType
}
TranslationKeyModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
key -
String!
|
|
translations -
TranslationPageModel!
|
|
Arguments |
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
Example
{
"id": "4",
"key": "abc123",
"translations": TranslationPageModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
TranslationKeyOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
TranslationKeyOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
TranslationKeyOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"createdAt"
TranslationKeyPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[TranslationKeyModel!]!
|
Example
{"totalCount": 123, "data": [TranslationKeyModel]}
TranslationKeyUpdateDto
Fields
| Input Field | Description |
|---|---|
translations -
[TranslationUpsertDto!]
|
Example
{"translations": [TranslationUpsertDto]}
TranslationModel
TranslationOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
TranslationOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
TranslationOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"createdAt"
TranslationPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[TranslationModel!]!
|
Example
{"totalCount": 123, "data": [TranslationModel]}
TranslationUpsertDto
UpdateNotificationPreferenceDto
UserAccessModel
Fields
| Field Name | Description |
|---|---|
access -
JsonObject!
|
|
platform -
JsonObject!
|
|
project -
JsonObject!
|
Example
{
"access": JsonObject,
"platform": JsonObject,
"project": JsonObject
}
UserConnectedProviderModel
UserCreateDto
Fields
| Input Field | Description |
|---|---|
reference -
String!
|
|
email -
String!
|
|
phone -
String
|
|
firstName -
String
|
|
lastName -
String
|
|
locale -
String
|
|
timezone -
String
|
|
isOptedIn -
Boolean
|
|
active -
Boolean
|
|
avatarUrl -
String
|
|
customData -
JsonObject
|
|
tenantId -
ID
|
|
password -
String
|
|
roles -
[String!]
|
|
twoFactorEnabled -
Boolean
|
Example
{
"reference": "xyz789",
"email": "xyz789",
"phone": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"locale": "xyz789",
"timezone": "abc123",
"isOptedIn": false,
"active": true,
"avatarUrl": "abc123",
"customData": JsonObject,
"tenantId": 4,
"password": "xyz789",
"roles": ["xyz789"],
"twoFactorEnabled": false
}
UserFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
email -
StringFilterArgType
|
|
phone -
StringFilterArgType
|
|
firstName -
StringFilterArgType
|
|
lastName -
StringFilterArgType
|
|
locale -
StringFilterArgType
|
|
timezone -
StringFilterArgType
|
|
optedInAt -
DateFilterArgType
|
|
active -
BooleanFilterArgType
|
|
withDeactivated -
BooleanFilterArgType
|
|
userProviderId -
IdFilterArgType
|
|
userGroupId -
UserGroupIdFilterArgType
|
|
userGroupName -
UserGroupNameFilterArgType
|
|
roleId -
IdFilterArgType
|
|
tenantId -
IdFilterArgType
|
|
roleKey -
StringFilterArgType
|
|
reference -
StringFilterArgType
|
|
search -
String
|
Example
{
"id": IdFilterArgType,
"email": StringFilterArgType,
"phone": StringFilterArgType,
"firstName": StringFilterArgType,
"lastName": StringFilterArgType,
"locale": StringFilterArgType,
"timezone": StringFilterArgType,
"optedInAt": DateFilterArgType,
"active": BooleanFilterArgType,
"withDeactivated": BooleanFilterArgType,
"userProviderId": IdFilterArgType,
"userGroupId": UserGroupIdFilterArgType,
"userGroupName": UserGroupNameFilterArgType,
"roleId": IdFilterArgType,
"tenantId": IdFilterArgType,
"roleKey": StringFilterArgType,
"reference": StringFilterArgType,
"search": "xyz789"
}
UserGroupCreateDto
UserGroupFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
type -
StringFilterArgType
|
|
name -
StringFilterArgType
|
|
reference -
StringFilterArgType
|
|
userId -
IdFilterArgType
|
|
roleId -
IdFilterArgType
|
Example
{
"id": IdFilterArgType,
"type": StringFilterArgType,
"name": StringFilterArgType,
"reference": StringFilterArgType,
"userId": IdFilterArgType,
"roleId": IdFilterArgType
}
UserGroupIdFilterArgType
UserGroupModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
type -
String!
|
|
name -
String!
|
|
reference -
String!
|
|
userGroupType -
UserGroupTypeModel
|
|
users -
UserPageModel
|
|
Arguments
|
|
roles -
RolePageModel!
|
|
Example
{
"id": "4",
"type": "xyz789",
"name": "xyz789",
"reference": "xyz789",
"userGroupType": UserGroupTypeModel,
"users": UserPageModel,
"roles": RolePageModel
}
UserGroupNameFilterArgType
Example
{
"equalTo": "abc123",
"notEqualTo": "xyz789",
"valueNotIn": ["xyz789"],
"valueIn": ["xyz789"],
"like": "abc123",
"iLike": "xyz789",
"all": ["abc123"]
}
UserGroupOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
UserGroupOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
UserGroupOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
UserGroupPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[UserGroupModel!]!
|
Example
{"totalCount": 987, "data": [UserGroupModel]}
UserGroupSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
UserGroupSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "type", "value": "abc123"}
UserGroupSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"type"
UserGroupTypeModel
UserGroupUpdateDto
UserInviteCreateDto
Fields
| Input Field | Description |
|---|---|
email -
String!
|
|
firstName -
String
|
|
lastName -
String
|
|
locale -
String
|
|
data -
JsonObject
|
|
status -
UserInviteStatusEnum
|
|
createdByUserId -
ID!
|
|
tenantId -
ID
|
|
roles -
[String!]
|
Example
{
"email": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"locale": "xyz789",
"data": JsonObject,
"status": "accepted",
"createdByUserId": 4,
"tenantId": "4",
"roles": ["abc123"]
}
UserInviteCreateV2Dto
Example
{
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"injectableVariables": JsonObject,
"createdByUserId": "4",
"roles": ["abc123"]
}
UserInviteFilterArgType
Fields
| Input Field | Description |
|---|---|
id -
IdFilterArgType
|
|
email -
StringFilterArgType
|
|
firstName -
StringFilterArgType
|
|
lastName -
StringFilterArgType
|
|
locale -
StringFilterArgType
|
|
status -
StringFilterArgType
|
|
createdByUserId -
IdFilterArgType
|
|
userTokenId -
IdFilterArgType
|
|
acceptedByUserId -
IdFilterArgType
|
|
tenantId -
IdFilterArgType
|
Example
{
"id": IdFilterArgType,
"email": StringFilterArgType,
"firstName": StringFilterArgType,
"lastName": StringFilterArgType,
"locale": StringFilterArgType,
"status": StringFilterArgType,
"createdByUserId": IdFilterArgType,
"userTokenId": IdFilterArgType,
"acceptedByUserId": IdFilterArgType,
"tenantId": IdFilterArgType
}
UserInviteModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
email -
String!
|
|
firstName -
String
|
|
lastName -
String
|
|
locale -
String
|
|
data -
JsonObject
|
|
status -
UserInviteStatusEnum!
|
|
createdByUserId -
ID!
|
|
createdBy -
UserModel!
|
|
Arguments
|
|
userTokenId -
ID!
|
|
acceptedByUserId -
ID
|
|
tenantId -
ID
|
|
roleKeys -
[String!]
|
|
acceptedBy -
UserModel
|
|
Arguments
|
|
createdAt -
Date!
|
|
updatedAt -
Date
|
|
statusUpdatedAt -
Date
|
|
roles -
RolePageModel
|
|
Arguments
|
|
Example
{
"id": "4",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "abc123",
"data": JsonObject,
"status": "accepted",
"createdByUserId": "4",
"createdBy": UserModel,
"userTokenId": "4",
"acceptedByUserId": "4",
"tenantId": "4",
"roleKeys": ["abc123"],
"acceptedBy": UserModel,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03",
"statusUpdatedAt": "2007-12-03",
"roles": RolePageModel
}
UserInviteOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
UserInviteOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
UserInviteOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
UserInvitePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[UserInviteModel!]!
|
Example
{"totalCount": 987, "data": [UserInviteModel]}
UserInviteSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
UserInviteSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "firstName", "value": "xyz789"}
UserInviteSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"firstName"
UserInviteStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"accepted"
UserInviteUpdateDto
Fields
| Input Field | Description |
|---|---|
firstName -
String
|
|
lastName -
String
|
|
locale -
String
|
|
data -
JsonObject
|
|
acceptedByUserId -
ID
|
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"data": JsonObject,
"acceptedByUserId": 4
}
UserInvitesCreateDto
Fields
| Input Field | Description |
|---|---|
userInvites -
[UserInviteCreateDto!]!
|
|
tenantId -
ID
|
Example
{
"userInvites": [UserInviteCreateDto],
"tenantId": "4"
}
UserInvitesCreateV2Dto
Fields
| Input Field | Description |
|---|---|
userInvites -
[UserInviteCreateV2Dto!]!
|
|
tenantId -
ID!
|
Example
{
"userInvites": [UserInviteCreateV2Dto],
"tenantId": "4"
}
UserModel
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
email -
String!
|
|
reference -
String!
|
|
phone -
String
|
|
firstName -
String
|
|
lastName -
String
|
|
locale -
String
|
|
timezone -
String
|
|
isOptedIn -
Boolean
|
|
synced -
Boolean
|
|
active -
Boolean
|
|
customData -
JsonObject
|
|
avatarUrl -
String
|
|
userGroups -
UserGroupPageModel
|
|
Arguments
|
|
roles -
RolePageModel
|
|
Arguments
|
|
tenantId -
ID
|
|
tenant -
TenantModel
|
|
twoFactorEnabled -
Boolean
|
|
createdAt -
Date!
|
|
updatedAt -
Date!
|
|
Example
{
"id": 4,
"email": "abc123",
"reference": "abc123",
"phone": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"timezone": "abc123",
"isOptedIn": true,
"synced": true,
"active": false,
"customData": JsonObject,
"avatarUrl": "xyz789",
"userGroups": UserGroupPageModel,
"roles": RolePageModel,
"tenantId": "4",
"tenant": TenantModel,
"twoFactorEnabled": true,
"createdAt": "2007-12-03",
"updatedAt": "2007-12-03"
}
UserOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
UserOrderSortEnum!
|
Example
{"order": "ASC", "sort": "createdAt"}
UserOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"createdAt"
UserPageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[UserModel!]!
|
Example
{"totalCount": 123, "data": [UserModel]}
UserPasswordUpdateDto
UserProfileModel
Example
{
"id": 4,
"reference": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "abc123",
"avatarUrl": "abc123",
"timezone": "xyz789",
"phone": "xyz789",
"connectedProviders": [UserConnectedProviderModel]
}
UserProfileOrderArgType
Fields
| Input Field | Description |
|---|---|
order -
OrderEnum!
|
|
sort -
UserProfileOrderSortEnum!
|
Example
{"order": "ASC", "sort": "firstName"}
UserProfileOrderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"firstName"
UserProfilePageModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
|
data -
[UserProfileModel!]!
|
Example
{"totalCount": 987, "data": [UserProfileModel]}
UserProfileSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
UserSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "phone", "value": "xyz789"}
UserSearchArgType
Fields
| Input Field | Description |
|---|---|
key -
UserSearchKeyEnum!
|
|
value -
String!
|
Example
{"key": "phone", "value": "abc123"}
UserSearchKeyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"phone"
UserUpdateDto
Example
{
"email": "xyz789",
"phone": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"locale": "abc123",
"timezone": "xyz789",
"isOptedIn": true,
"tenantId": 4,
"active": false,
"avatarUrl": "abc123",
"customData": JsonObject,
"twoFactorEnabled": true
}
UserUpdateProfileDto
UsersCountModel
Fields
| Field Name | Description |
|---|---|
totalCount -
Int!
|
Example
{"totalCount": 123}