Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

SuiteListResponseDTO

Paginated response containing a list of suites.

pagination

Pagination information

List of suites

Sample
{ "pagination": { "__typename": "Pagination" }, "suiteList": [ { "__typename": "SuiteListItemDTO" } ] }

SuiteProductDTO

Suite product details in response.

productName
String

Name of the product

quantity
Int

Quantity of the product

state
String

State of the product

version
String

Version of the product

Sample
{ "productName": "Example String", "quantity": 40, "state": "Example String", "version": "Example String" }
Referenced in

SuiteResponseDTO

Response containing a single suite.

The suite data

Sample
{ "suite": { "__typename": "SuiteDTO" } }

UserAccount

Account information associated with a user

accountId
String!,non-null

Unique identifier for the account

accountName
String!,non-null

Name of the account

accountType
String

Type of the account

expiryDate
String

Expiration date of the account access

roles
[String!]!,non-null

Roles assigned to the user for this account

Sample
{ "accountId": "Example String", "accountName": "Example String", "accountType": "Example String", "expiryDate": "Example String", "roles": [ "Example String" ] }
Referenced in

UserCreationResponse

Response returned after attempting to create a user

message
String

User creation success message

status
String

Status of the user created

Sample
{ "message": "Example String", "status": "Example String" }

UserDetail

Response returned after getting user details with account information

accounts

Accounts associated with the user

attributes

Represents the custom attributes associated with the account

city
String

City of the user

country
String

Country of the user

displayName
String

Display name of the user

emailAddress
String

Email address of the user

faxNumber
String

Fax number of the user

firstName
String

First name of the user

lastName
String

Last name of the user

locale
String

Locale preference of the user

optIn
Boolean

Whether the user has opted in for communications

phoneNumber
String

Phone number of the user

portalLogin
Boolean

Whether the user can login

shared
Boolean

Whether the user is shared across accounts

state
String

State or province of the user

status
String

Status of the user account (active/inactive)

street
String

Street address of the user

timezone
String

Timezone preference of the user

userName
String

Username of the user

zipcode
String

Postal/ZIP code of the user

Sample
{ "accounts": [ { "__typename": "UserAccount" } ], "attributes": [ { "__typename": "Attribute" } ], "city": "Example String", "country": "Example String", "displayName": "Example String", "emailAddress": "Example String", "faxNumber": "Example String", "firstName": "Example String", "lastName": "Example String", "locale": "Example String", "optIn": true, "phoneNumber": "Example String", "portalLogin": true, "shared": true, "state": "Example String", "status": "Example String", "street": "Example String", "timezone": "Example String", "userName": "Example String", "zipcode": "Example String" }

UserInfo

Response returned after getting user info without account information

attributes

Represents the custom attributes associated with the account

city
String

City of the user

country
String

Country of the user

displayName
String

Display name of the user

emailAddress
String

Email address of the user

faxNumber
String

Fax number of the user

firstName
String

First name of the user

lastName
String

Last name of the user

locale
String

Locale preference of the user

optIn
Boolean

Whether the user has opted in for communications

phoneNumber
String

Phone number of the user

portalLogin
Boolean

Whether the user can login

shared
Boolean

Whether the user is shared across accounts

state
String

State or province of the user

status
String

Status of the user account (active/inactive)

street
String

Street address of the user

timezone
String

Timezone preference of the user

userName
String

Username of the user

zipcode
String

Postal/ZIP code of the user

Sample
{ "attributes": [ { "__typename": "Attribute" } ], "city": "Example String", "country": "Example String", "displayName": "Example String", "emailAddress": "Example String", "faxNumber": "Example String", "firstName": "Example String", "lastName": "Example String", "locale": "Example String", "optIn": true, "phoneNumber": "Example String", "portalLogin": true, "shared": true, "state": "Example String", "status": "Example String", "street": "Example String", "timezone": "Example String", "userName": "Example String", "zipcode": "Example String" }

Inputs

Overview

Scalars

Overview