GraphQL Account API Reference

GraphQL Account API Reference

Queries

account

Description

An account.

Response

Returns an Account!

Example

Query
query account {
  account {
    accountInfo {
      ...AccountInfoFragment
    }
    apps {
      ...AppsConnectionFragment
    }
    id
    stores {
      ...StoreConnectionFragment
    }
    users {
      ...UserConnectionFragment
    }
  }
}
Response
{
  "data": {
    "account": {
      "accountInfo": AccountInfo,
      "apps": AppsConnection,
      "id": 4,
      "stores": StoreConnection,
      "users": UserConnection
    }
  }
}
Queries

node

Description

Fetches an object given its ID.

Response

Returns a Node

Arguments
Name Description
id - ID! The ID of the object.

Example

Query
query node($id: ID!) {
  node(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"node": {"id": "4"}}}
Queries

nodes

Description

Fetches objects given their IDs.

Response

Returns [Node]!

Arguments
Name Description
ids - [ID!]! The IDs of the objects.

Example

Query
query nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    id
  }
}
Variables
{"ids": [4]}
Response
{"data": {"nodes": [{"id": 4}]}}
Queries

system

Description

System settings.

Response

Returns a System!

Example

Query
query system {
  system {
    time
  }
}
Response
{"data": {"system": {"time": {}}}}

Mutations

account

Description

Account mutations.

Response

Returns an AccountMutations!

Example

Query
mutation account {
  account {
    addUserToAccount {
      ...AddUserToAccountResultFragment
    }
    removeUserFromAccount {
      ...RemoveUserFromAccountResultFragment
    }
  }
}
Response
{
  "data": {
    "account": {
      "addUserToAccount": AddUserToAccountResult,
      "removeUserFromAccount": RemoveUserFromAccountResult
    }
  }
}
Mutations

app

Description

App mutations.

Response

Returns an AppMutations!

Example

Query
mutation app {
  app {
    createEventSource {
      ...CreateEventSourceResultFragment
    }
    deleteEventSource {
      ...DeleteEventSourceResultFragment
    }
  }
}
Response
{
  "data": {
    "app": {
      "createEventSource": CreateEventSourceResult,
      "deleteEventSource": DeleteEventSourceResult
    }
  }
}
Mutations

user

Description

User mutations.

Response

Returns a UserMutations!

Example

Query
mutation user {
  user {
    addUserToStore {
      ...AddUserToStoreResultFragment
    }
    createUserWithPassword {
      ...CreateUserWithPasswordResultFragment
    }
    removeUserFromStore {
      ...RemoveUserFromStoreResultFragment
    }
  }
}
Response
{
  "data": {
    "user": {
      "addUserToStore": AddUserToStoreResult,
      "createUserWithPassword": CreateUserWithPasswordResult,
      "removeUserFromStore": RemoveUserFromStoreResult
    }
  }
}

Types

Account

Description

An account.

Fields
Field Name Description
accountInfo - AccountInfo! Provides account details.
apps - AppsConnection! Apps owned by the account.
Arguments
before - String
after - String
first - Int
last - Int
id - ID! The ID of the object.
stores - StoreConnection! The stores related to an account.
Arguments
before - String
after - String
first - Int
last - Int
users - UserConnection! Users belonging to the account.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "accountInfo": AccountInfo,
  "apps": AppsConnection,
  "id": "4",
  "stores": StoreConnection,
  "users": UserConnection
}
Types

AccountInfo

Description

Account details.

Fields
Field Name Description
name - String! The name of an account.
Example
{"name": "xyz789"}
Types

AccountMutations

Description

Account mutations.

Fields
Field Name Description
addUserToAccount - AddUserToAccountResult Adds a user to an account.
Arguments
input - AddUserToAccountInput!
removeUserFromAccount - RemoveUserFromAccountResult Removes a user from an account.
Arguments
input - RemoveUserFromAccountInput!
Example
{
  "addUserToAccount": AddUserToAccountResult,
  "removeUserFromAccount": RemoveUserFromAccountResult
}
Types

AddUserToAccountInput

Fields
Input Field Description
email - String! The email of the user to be added to the account.
Example
{"email": "xyz789"}
Types

AddUserToAccountResult

Fields
Field Name Description
account - Account An account the user was added to.
Example
{"account": Account}
Types

AddUserToStoreInput

Fields
Input Field Description
storeId - ID! The store the user is to be added.
user - UserIdentifierInput! The user to be added to the store.
Example
{"storeId": 4, "user": UserIdentifierInput}
Types

AddUserToStoreResult

Fields
Field Name Description
storeId - ID! The ID of the object.
Example
{"storeId": "4"}
Types

App

Description

An application.

Fields
Field Name Description
id - ID! The ID of the object.
name - String! The app name.
eventSources - AwsEventSourcesConnection! Amazon EventSources.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "id": "4",
  "name": "xyz789",
  "eventSources": AwsEventSourcesConnection
}
Types

AppMutations

Description

App mutations.

Fields
Field Name Description
createEventSource - CreateEventSourceResult Creates an Amazon EventSource.
Arguments
input - CreateEventSourceInput!
deleteEventSource - DeleteEventSourceResult Deletes an Amazon EventSource.
Arguments
input - DeleteEventSourceInput!
Example
{
  "createEventSource": CreateEventSourceResult,
  "deleteEventSource": DeleteEventSourceResult
}
Types

AppsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [AppsEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [AppsEdge]
}
Types

AppsEdge

Description

An edge in a connection.

Fields
Field Name Description
node - App! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": App,
  "cursor": "xyz789"
}
Types

AwsEventSource

Description

An Amazon EventSource.

Fields
Field Name Description
id - ID! The ID of an object.
awsAccount - String! An Amazon EventSource account ID.
eventSourceName - String! An event source name.
eventSourceRegion - AwsRegion! The region of an event source.
arn - String! An Amazon EventSource resource name.
webhooksCount - Long! Number of webhooks attached to an Amazon EventSource.
Example
{
  "id": "4",
  "awsAccount": "xyz789",
  "eventSourceName": "abc123",
  "eventSourceRegion": "AF_SOUTH_1",
  "arn": "abc123",
  "webhooksCount": {}
}
Types

AwsEventSourcesConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [AwsEventSourcesEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [AwsEventSourcesEdge]
}
Types

AwsEventSourcesEdge

Description

An edge in a connection.

Fields
Field Name Description
node - AwsEventSource! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": AwsEventSource,
  "cursor": "xyz789"
}
Types

AwsRegion

Description

The Amazon EventSource region.

Values
Enum Value Description

AF_SOUTH_1

 af-south-1

AP_EAST_1

 ap-east-1

AP_NORTHEAST_1

 ap-northeast-1

AP_NORTHEAST_2

 ap-northeast-2

AP_NORTHEAST_3

 ap-northeast-3

AP_SOUTHEAST_1

 ap-southeast-1

AP_SOUTHEAST_2

 ap-southeast-2

AP_SOUTHEAST_3

 ap-southeast-3

AP_SOUTHEAST_4

 ap-southeast-4

AP_SOUTH_1

 ap-south-1

AP_SOUTH_2

 ap-south-2

CA_CENTRAL_1

 ca-central-1

EU_CENTRAL_1

 eu-central-1

EU_CENTRAL_2

 eu-central-2

EU_NORTH_1

 eu-north-1

EU_SOUTH_1

 eu-south-1

EU_SOUTH_2

 eu-south-2

EU_WEST_1

 eu-west-1

EU_WEST_2

 eu-west-2

EU_WEST_3

 eu-west-3

IL_CENTRAL_1

 il-central-1

ME_CENTRAL_1

 me-central-1

SA_EAST_1

 sa-east-1

US_EAST_1

 us-east-1

US_EAST_2

 us-east-2

US_WEST_1

 us-west-1

US_WEST_2

 us-west-2
Example
"AF_SOUTH_1"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

CollectionInfo

Description

Collection details.

Fields
Field Name Description
totalItems - Long The total number of items in the collection.
Example
{"totalItems": {}}
Types

CreateEventSourceInput

Fields
Input Field Description
appId - ID! The ID of an app.
awsAccount - String! An Amazon EventSource account ID.
eventSourceName - String! An event source name.
eventSourceRegion - AwsRegion! The region of an event source.
Example
{
  "appId": 4,
  "awsAccount": "xyz789",
  "eventSourceName": "abc123",
  "eventSourceRegion": "AF_SOUTH_1"
}
Types

CreateEventSourceResult

Fields
Field Name Description
eventSource - AwsEventSource The Amazon EventSource created as a result of mutation.
Example
{"eventSource": AwsEventSource}
Types

CreateUserWithPasswordInput

Fields
Input Field Description
email - String! The email of the user to be added to the account.
firstName - String! The first name of the user to be added to the account.
lastName - String! The last name of the user to be added to the account.
locale - String! The locale of the user to be added to the account.
password - String! The password of the user to be added to the account.
passwordConfirmation - String! Enter password again to confirm.
Example
{
  "email": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "locale": "abc123",
  "password": "abc123",
  "passwordConfirmation": "abc123"
}
Types

CreateUserWithPasswordResult

Fields
Field Name Description
user - User Created user.
Example
{"user": User}
Types

DateTime

Description

ISO-8601 formatted date in UTC

Example
"2007-12-03T10:15:30Z"
Types

DeleteEventSourceInput

Fields
Input Field Description
appId - ID! The ID of an app.
id - ID! The ID of the object.
Example
{
  "appId": "4",
  "id": "4"
}
Types

DeleteEventSourceResult

Fields
Field Name Description
deletedEventSourceId - ID! The ID of the object.
affectedWebhooksIds - [ID!]! The IDs of affected webhooks by event source delete mutation. Their status is automatically changed to disabled.
Example
{
  "deletedEventSourceId": "4",
  "affectedWebhooksIds": ["4"]
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to re-fetch an object or as key for a cache.

Example
"4"
Types

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
Types

Long

Description

The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example
{}
Types

Node

Description

An object with an ID.

Fields
Field Name Description
id - ID! The ID of the object.
Example
{"id": 4}
Types

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "xyz789",
  "endCursor": "abc123"
}
Types

RemoveUserFromAccountInput

Description

Input needed to remove a user from an account.

Fields
Input Field Description
email - String The email of the user to be removed from the account.
userId - ID The id of the user to be removed.
Example
{
  "email": "abc123",
  "userId": "4"
}
Types

RemoveUserFromAccountResult

Fields
Field Name Description
accountId - ID! The ID of the object.
userId - ID! The ID of the object.
Example
{
  "accountId": "4",
  "userId": "4"
}
Types

RemoveUserFromStoreInput

Fields
Input Field Description
storeId - ID! The store from which user is to be removed.
userId - ID! The user to be removed.
Example
{"storeId": 4, "userId": 4}
Types

RemoveUserFromStoreResult

Fields
Field Name Description
storeId - ID! The store from which the user is removed from.
user - User Removed user.
Example
{
  "storeId": "4",
  "user": User
}
Types

Store

Description

A store related to an account.

Fields
Field Name Description
id - ID! The ID of the object.
apps - AppsConnection! The list of store apps.
Arguments
before - String
after - String
first - Int
last - Int
name - String! The store name for the store.
storeHash - String! The store hash for the store.
users - StoreUserConnection! Users belonging to the store.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "id": "4",
  "apps": AppsConnection,
  "name": "xyz789",
  "storeHash": "abc123",
  "users": StoreUserConnection
}
Types

StoreConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [StoreEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [StoreEdge]
}
Types

StoreEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Store! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Store,
  "cursor": "xyz789"
}
Types

StoreUser

Description

A user belonging to a store.

Fields
Field Name Description
id - ID! The ID of the object.
apps - AppsConnection! Apps accessible by the user on the store.
Arguments
before - String
after - String
first - Int
last - Int
email - String! The email for the user.
firstName - String! First name.
lastLoginAt - DateTime When the user last logged in.
lastName - String! Last name.
locale - String! User preferred locale.
permissions - [String!]! The permissions for the user on the store.
status - StoreUserStatus Current status of the user for the store.
updatedAt - DateTime When was the user last updated.
Example
{
  "id": 4,
  "apps": AppsConnection,
  "email": "abc123",
  "firstName": "xyz789",
  "lastLoginAt": "2007-12-03T10:15:30Z",
  "lastName": "abc123",
  "locale": "abc123",
  "permissions": ["xyz789"],
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

StoreUserConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [StoreUserEdge] A list of edges.
collectionInfo - CollectionInfo Collection details.
Example
{
  "pageInfo": PageInfo,
  "edges": [StoreUserEdge],
  "collectionInfo": CollectionInfo
}
Types

StoreUserEdge

Description

An edge in a connection.

Fields
Field Name Description
node - StoreUser! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": StoreUser,
  "cursor": "abc123"
}
Types

StoreUserStatus

Description

The status of the user on the store.

Values
Enum Value Description

ACTIVE

 The user is active.

INACTIVE

 The user is inactive.
Example
"ACTIVE"
Types

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
"xyz789"
Types

System

Description

System settings.

Fields
Field Name Description
time - Long! The current time.
Example
{"time": {}}
Types

User

Description

A user belonging to an account.

Fields
Field Name Description
id - ID! The ID of the object.
email - String! The email for the user.
firstName - String! First name.
lastName - String! Last name.
locale - String! User preferred locale.
Example
{
  "id": "4",
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "locale": "xyz789"
}
Types

UserConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [UserEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [UserEdge]
}
Types

UserEdge

Description

An edge in a connection.

Fields
Field Name Description
node - User! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": User,
  "cursor": "xyz789"
}
Types

UserIdentifierInput

Description

The user to add to the store.

Fields
Input Field Description
email - String The email of the user to be added to the store.
id - ID The ID of the user to be added.
Example
{
  "email": "abc123",
  "id": "4"
}
Types

UserMutations

Description

User mutations.

Fields
Field Name Description
addUserToStore - AddUserToStoreResult Adds a user to a store.
Arguments
input - AddUserToStoreInput!
createUserWithPassword - CreateUserWithPasswordResult Creates a user with password.
Arguments
input - CreateUserWithPasswordInput!
removeUserFromStore - RemoveUserFromStoreResult Removes user from a store.
Arguments
input - RemoveUserFromStoreInput!
Example
{
  "addUserToStore": AddUserToStoreResult,
  "createUserWithPassword": CreateUserWithPasswordResult,
  "removeUserFromStore": RemoveUserFromStoreResult
}