VAULT3 GraphQL API Reference

Welcome to the party!

Contact

Support on Discord

Terms of Service

API Endpoints

# Production:
https://api.vault3.io/api/graphql

Headers

# Either your personal or enterprise access token
Authorization: <YOUR_TOKEN_HERE>

Enterprise access

Queries

`accessConditionById`

Response

Returns an AccessCondition

Arguments

Name	Description
`id` - `String!`

Example

Query

query accessConditionById($id: String!) {
  accessConditionById(id: $id) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "accessConditionById": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Queries

`accessConditionByName`

Response

Returns an AccessCondition

Arguments

Name	Description
`name` - `String!`

Example

Query

query accessConditionByName($name: String!) {
  accessConditionByName(name: $name) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{"name": "abc123"}

Response

{
  "data": {
    "accessConditionByName": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Queries

`accessConditions`

Response

Returns [AccessCondition!]!

Example

Query

query accessConditions {
  accessConditions {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Response

{
  "data": {
    "accessConditions": [
      {
        "assetOwnerSettings": AccessConditionAssetOwnerSettings,
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "abc123",
        "id": 4,
        "name": "xyz789",
        "poolDelegationSettings": AccessConditionPoolDelegationSettings,
        "type": "ASSET_OWNER",
        "updatedAt": "2007-12-03T10:15:30Z",
        "whitelistSettings": AccessConditionWhitelistSettings
      }
    ]
  }
}

Queries

`checkFormAccess`

Response

Returns a CheckFormAccessResult!

Arguments

Name	Description
`formId` - `String!`

Example

Query

query checkFormAccess($formId: String!) {
  checkFormAccess(formId: $formId) {
    hasAccess
  }
}

Variables

{"formId": "xyz789"}

Response

{"data": {"checkFormAccess": {"hasAccess": false}}}

Queries

`checkFormEntryConditions`

Response

Returns a Boolean!

Arguments

Name	Description
`formId` - `String!`

Example

Query

query checkFormEntryConditions($formId: String!) {
  checkFormEntryConditions(formId: $formId)
}

Variables

{"formId": "xyz789"}

Response

{"data": {"checkFormEntryConditions": false}}

Queries

`checkSpaceAccess`

Response

Returns a CheckSpaceAccessResult!

Arguments

Name	Description
`spaceId` - `String!`

Example

Query

query checkSpaceAccess($spaceId: String!) {
  checkSpaceAccess(spaceId: $spaceId) {
    hasAccess
  }
}

Variables

{"spaceId": "abc123"}

Response

{"data": {"checkSpaceAccess": {"hasAccess": true}}}

Queries

`downloadFile`

Response

Returns a DecryptedFile!

Arguments

Name	Description
`id` - `String!`

Example

Query

query downloadFile($id: String!) {
  downloadFile(id: $id) {
    content
    id
    mime
    name
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "downloadFile": {
      "content": "xyz789",
      "id": "abc123",
      "mime": "xyz789",
      "name": "xyz789"
    }
  }
}

Queries

`downloadFilesFromSpace`

Response

Returns a Space

Arguments

Name	Description
`id` - `String!`

Example

Query

query downloadFilesFromSpace($id: String!) {
  downloadFilesFromSpace(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "downloadFilesFromSpace": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "xyz789",
      "download": [DecryptedFile],
      "files": [File],
      "id": 4,
      "isActive": false,
      "name": "xyz789",
      "slug": "abc123",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`fileById`

Response

Returns a File

Arguments

Name	Description
`id` - `String!`

Example

Query

query fileById($id: String!) {
  fileById(id: $id) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "fileById": {
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": 4,
      "mime": "abc123",
      "name": "xyz789",
      "space": Space,
      "spaceId": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`files`

Response

Returns [File!]!

Example

Query

query files {
  files {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Response

{
  "data": {
    "files": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "abc123",
        "id": 4,
        "mime": "xyz789",
        "name": "abc123",
        "space": Space,
        "spaceId": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`filesInSpace`

Response

Returns [File!]!

Arguments

Name	Description
`spaceId` - `String!`

Example

Query

query filesInSpace($spaceId: String!) {
  filesInSpace(spaceId: $spaceId) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Variables

{"spaceId": "abc123"}

Response

{
  "data": {
    "filesInSpace": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "xyz789",
        "id": "4",
        "mime": "abc123",
        "name": "abc123",
        "space": Space,
        "spaceId": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`formAccessConditionsByAccessCondition`

Response

Returns [FormAccessCondition!]

Arguments

Name	Description
`accessConditionId` - `String!`

Example

Query

query formAccessConditionsByAccessCondition($accessConditionId: String!) {
  formAccessConditionsByAccessCondition(accessConditionId: $accessConditionId) {
    accessCondition {
      ...AccessConditionFragment
    }
    form {
      ...FormFragment
    }
    id
  }
}

Variables

{"accessConditionId": "abc123"}

Response

{
  "data": {
    "formAccessConditionsByAccessCondition": [
      {
        "accessCondition": AccessCondition,
        "form": Form,
        "id": 4
      }
    ]
  }
}

Queries

`formById`

Response

Returns a Form

Arguments

Name	Description
`id` - `String!`

Example

Query

query formById($id: String!) {
  formById(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "formById": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "abc123",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": 4,
      "isActive": true,
      "name": "xyz789",
      "slug": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`formEntriesByFormId`

Response

Returns [FormEntry!]

Arguments

Name	Description
`id` - `String!`

Example

Query

query formEntriesByFormId($id: String!) {
  formEntriesByFormId(id: $id) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    form {
      ...FormFragment
    }
    formId
    id
    stakeKey
    updatedAt
    values
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "formEntriesByFormId": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "abc123",
        "form": Form,
        "formId": "xyz789",
        "id": 4,
        "stakeKey": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "values": {}
      }
    ]
  }
}

Queries

`formSlugAvailable`

Response

Returns a Boolean!

Arguments

Name	Description
`ignoreFormId` - `String`
`slug` - `String!`

Example

Query

query formSlugAvailable(
  $ignoreFormId: String,
  $slug: String!
) {
  formSlugAvailable(
    ignoreFormId: $ignoreFormId,
    slug: $slug
  )
}

Variables

{
  "ignoreFormId": "xyz789",
  "slug": "abc123"
}

Response

{"data": {"formSlugAvailable": true}}

Queries

`forms`

Response

Returns [Form!]!

Example

Query

query forms {
  forms {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Response

{
  "data": {
    "forms": [
      {
        "activeSince": "2007-12-03T10:15:30Z",
        "branding": BrandingSettings,
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "xyz789",
        "description": "abc123",
        "fields": [FormField],
        "formAccessConditions": [FormAccessCondition],
        "id": 4,
        "isActive": true,
        "name": "abc123",
        "slug": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`me`

Response

Returns a User!

Example

Query

query me {
  me {
    cardanoAddress
    id
    spaces {
      ...SpaceFragment
    }
  }
}

Response

{
  "data": {
    "me": {
      "cardanoAddress": "xyz789",
      "id": 4,
      "spaces": [Space]
    }
  }
}

Queries

`metricDashboardKeyIndicators`

Response

Returns a DashboardKeyMetric!

Arguments

Name	Description
`spaceId` - `String`

Example

Query

query metricDashboardKeyIndicators($spaceId: String) {
  metricDashboardKeyIndicators(spaceId: $spaceId) {
    ctaEngagement
    totalConnectedWallets
    totalForms
    totalInteractions
    totalSpaces
    totalUniqueEntries
    totalUnlocks
  }
}

Variables

{"spaceId": "xyz789"}

Response

{
  "data": {
    "metricDashboardKeyIndicators": {
      "ctaEngagement": 987.65,
      "totalConnectedWallets": 987,
      "totalForms": 123,
      "totalInteractions": 123,
      "totalSpaces": 987,
      "totalUniqueEntries": 987,
      "totalUnlocks": 123
    }
  }
}

Queries

`metricDashboardKeyIndicatorsForForm`

Response

Returns a DashboardKeyMetric!

Arguments

Name	Description
`formId` - `String`

Example

Query

query metricDashboardKeyIndicatorsForForm($formId: String) {
  metricDashboardKeyIndicatorsForForm(formId: $formId) {
    ctaEngagement
    totalConnectedWallets
    totalForms
    totalInteractions
    totalSpaces
    totalUniqueEntries
    totalUnlocks
  }
}

Variables

{"formId": "abc123"}

Response

{
  "data": {
    "metricDashboardKeyIndicatorsForForm": {
      "ctaEngagement": 987.65,
      "totalConnectedWallets": 987,
      "totalForms": 123,
      "totalInteractions": 123,
      "totalSpaces": 123,
      "totalUniqueEntries": 123,
      "totalUnlocks": 123
    }
  }
}

Queries

`metricDistributionEngagementCTA`

Response

Returns a DistributionEngagementCTAMetric!

Arguments

Name	Description
`spaceId` - `String`

Example

Query

query metricDistributionEngagementCTA($spaceId: String) {
  metricDistributionEngagementCTA(spaceId: $spaceId) {
    fallbackCTA
    successCTA
  }
}

Variables

{"spaceId": "abc123"}

Response

{
  "data": {
    "metricDistributionEngagementCTA": {
      "fallbackCTA": 987.65,
      "successCTA": 123.45
    }
  }
}

Queries

`metricDistributionEngagementCTAForForm`

Response

Returns a DistributionEngagementCTAMetric!

Arguments

Name	Description
`formId` - `String`

Example

Query

query metricDistributionEngagementCTAForForm($formId: String) {
  metricDistributionEngagementCTAForForm(formId: $formId) {
    fallbackCTA
    successCTA
  }
}

Variables

{"formId": "abc123"}

Response

{
  "data": {
    "metricDistributionEngagementCTAForForm": {
      "fallbackCTA": 987.65,
      "successCTA": 987.65
    }
  }
}

Queries

`metricFallbackFunnel`

Response

Returns a FallbackFunnelMetric!

Arguments

Name	Description
`spaceId` - `String`

Example

Query

query metricFallbackFunnel($spaceId: String) {
  metricFallbackFunnel(spaceId: $spaceId) {
    fallbackCTA
    unsuccessUnlocks
    views
  }
}

Variables

{"spaceId": "xyz789"}

Response

{
  "data": {
    "metricFallbackFunnel": {
      "fallbackCTA": 987,
      "unsuccessUnlocks": 987,
      "views": 123
    }
  }
}

Queries

`metricFallbackFunnelForForm`

Response

Returns a FallbackFunnelMetric!

Arguments

Name	Description
`formId` - `String`

Example

Query

query metricFallbackFunnelForForm($formId: String) {
  metricFallbackFunnelForForm(formId: $formId) {
    fallbackCTA
    unsuccessUnlocks
    views
  }
}

Variables

{"formId": "xyz789"}

Response

{
  "data": {
    "metricFallbackFunnelForForm": {
      "fallbackCTA": 123,
      "unsuccessUnlocks": 987,
      "views": 987
    }
  }
}

Queries

`metricSuccessFunnel`

Response

Returns a SuccessFunnelMetric!

Arguments

Name	Description
`spaceId` - `String`

Example

Query

query metricSuccessFunnel($spaceId: String) {
  metricSuccessFunnel(spaceId: $spaceId) {
    successCTA
    successUnlocks
    views
  }
}

Variables

{"spaceId": "abc123"}

Response

{
  "data": {
    "metricSuccessFunnel": {
      "successCTA": 987,
      "successUnlocks": 123,
      "views": 987
    }
  }
}

Queries

`metricSuccessFunnelForForm`

Response

Returns a SuccessFunnelMetric!

Arguments

Name	Description
`formId` - `String`

Example

Query

query metricSuccessFunnelForForm($formId: String) {
  metricSuccessFunnelForForm(formId: $formId) {
    successCTA
    successUnlocks
    views
  }
}

Variables

{"formId": "abc123"}

Response

{
  "data": {
    "metricSuccessFunnelForForm": {
      "successCTA": 987,
      "successUnlocks": 987,
      "views": 987
    }
  }
}

Queries

`metricTrendingSpaces`

Response

Returns a TrendingSpacesMetric!

Example

Query

query metricTrendingSpaces {
  metricTrendingSpaces {
    spaces {
      ...TrendingSpaceMetricFragment
    }
  }
}

Response

{
  "data": {
    "metricTrendingSpaces": {
      "spaces": [TrendingSpaceMetric]
    }
  }
}

Queries

`metricUnlocksPerForm`

Response

Returns an UnlocksPerFormMetric!

Example

Query

query metricUnlocksPerForm {
  metricUnlocksPerForm {
    forms {
      ...FormMetricFragment
    }
  }
}

Response

{
  "data": {
    "metricUnlocksPerForm": {"forms": [FormMetric]}
  }
}

Queries

`metricUnlocksPerSpace`

Response

Returns an UnlocksPerSpaceMetric!

Example

Query

query metricUnlocksPerSpace {
  metricUnlocksPerSpace {
    spaces {
      ...SpaceMetricFragment
    }
  }
}

Response

{
  "data": {
    "metricUnlocksPerSpace": {"spaces": [SpaceMetric]}
  }
}

Queries

`signatureChallenge`

Response

Returns a SignatureChallengeResponse!

Arguments

Name	Description
`address` - `String!`

Example

Query

query signatureChallenge($address: String!) {
  signatureChallenge(address: $address) {
    message
  }
}

Variables

{"address": "xyz789"}

Response

{
  "data": {
    "signatureChallenge": {
      "message": "abc123"
    }
  }
}

Queries

`spaceAccessConditionsByAccessCondition`

Response

Returns [SpaceAccessCondition!]

Arguments

Name	Description
`accessConditionId` - `String!`

Example

Query

query spaceAccessConditionsByAccessCondition($accessConditionId: String!) {
  spaceAccessConditionsByAccessCondition(accessConditionId: $accessConditionId) {
    accessCondition {
      ...AccessConditionFragment
    }
    id
    space {
      ...SpaceFragment
    }
  }
}

Variables

{"accessConditionId": "abc123"}

Response

{
  "data": {
    "spaceAccessConditionsByAccessCondition": [
      {
        "accessCondition": AccessCondition,
        "id": 4,
        "space": Space
      }
    ]
  }
}

Queries

`spaceById`

Response

Returns a Space

Arguments

Name	Description
`id` - `String!`

Example

Query

query spaceById($id: String!) {
  spaceById(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "spaceById": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "abc123",
      "download": [DecryptedFile],
      "files": [File],
      "id": 4,
      "isActive": true,
      "name": "xyz789",
      "slug": "xyz789",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`spaceSlugAvailable`

Response

Returns a Boolean!

Arguments

Name	Description
`ignoreSpaceId` - `String`
`slug` - `String!`

Example

Query

query spaceSlugAvailable(
  $ignoreSpaceId: String,
  $slug: String!
) {
  spaceSlugAvailable(
    ignoreSpaceId: $ignoreSpaceId,
    slug: $slug
  )
}

Variables

{
  "ignoreSpaceId": "abc123",
  "slug": "xyz789"
}

Response

{"data": {"spaceSlugAvailable": true}}

Queries

`spaces`

Response

Returns [Space!]!

Example

Query

query spaces {
  spaces {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Response

{
  "data": {
    "spaces": [
      {
        "activeSince": "2007-12-03T10:15:30Z",
        "branding": BrandingSettings,
        "createdAt": "2007-12-03T10:15:30Z",
        "creator": User,
        "creatorId": "xyz789",
        "description": "xyz789",
        "download": [DecryptedFile],
        "files": [File],
        "id": 4,
        "isActive": true,
        "name": "xyz789",
        "slug": "abc123",
        "spaceAccessConditions": [SpaceAccessCondition],
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Mutations

`createAssetOwnerAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`assetFingerprints` - `[String!]!`
`minAmount` - `Int!`
`name` - `String!`
`policyId` - `String!`

Example

Query

mutation createAssetOwnerAccessCondition(
  $assetFingerprints: [String!]!,
  $minAmount: Int!,
  $name: String!,
  $policyId: String!
) {
  createAssetOwnerAccessCondition(
    assetFingerprints: $assetFingerprints,
    minAmount: $minAmount,
    name: $name,
    policyId: $policyId
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "assetFingerprints": ["xyz789"],
  "minAmount": 123,
  "name": "abc123",
  "policyId": "xyz789"
}

Response

{
  "data": {
    "createAssetOwnerAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`createFile`

Response

Returns a File!

Arguments

Name	Description
`content` - `String!`
`mime` - `String!`
`name` - `String!`
`spaceId` - `String!`

Example

Query

mutation createFile(
  $content: String!,
  $mime: String!,
  $name: String!,
  $spaceId: String!
) {
  createFile(
    content: $content,
    mime: $mime,
    name: $name,
    spaceId: $spaceId
  ) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Variables

{
  "content": "abc123",
  "mime": "abc123",
  "name": "xyz789",
  "spaceId": "xyz789"
}

Response

{
  "data": {
    "createFile": {
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "id": 4,
      "mime": "xyz789",
      "name": "abc123",
      "space": Space,
      "spaceId": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`createForm`

Response

Returns a Form!

Arguments

Name	Description
`description` - `String`
`fields` - `[FormFieldInput!]`
`isActive` - `Boolean`	Default = `true`
`name` - `String!`
`slug` - `String!`

Example

Query

mutation createForm(
  $description: String,
  $fields: [FormFieldInput!],
  $isActive: Boolean,
  $name: String!,
  $slug: String!
) {
  createForm(
    description: $description,
    fields: $fields,
    isActive: $isActive,
    name: $name,
    slug: $slug
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{
  "description": "xyz789",
  "fields": [FormFieldInput],
  "isActive": true,
  "name": "abc123",
  "slug": "xyz789"
}

Response

{
  "data": {
    "createForm": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "xyz789",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": 4,
      "isActive": false,
      "name": "xyz789",
      "slug": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`createFormEntry`

Response

Returns a FormEntry!

Arguments

Name	Description
`formId` - `String!`
`values` - `JSONObject!`

Example

Query

mutation createFormEntry(
  $formId: String!,
  $values: JSONObject!
) {
  createFormEntry(
    formId: $formId,
    values: $values
  ) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    form {
      ...FormFragment
    }
    formId
    id
    stakeKey
    updatedAt
    values
  }
}

Variables

{"formId": "xyz789", "values": {}}

Response

{
  "data": {
    "createFormEntry": {
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "form": Form,
      "formId": "xyz789",
      "id": "4",
      "stakeKey": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "values": {}
    }
  }
}

Mutations

`createPoolDelegationAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`minDelegation` - `Int!`
`minEpochs` - `Int!`
`name` - `String!`
`poolId` - `String!`

Example

Query

mutation createPoolDelegationAccessCondition(
  $minDelegation: Int!,
  $minEpochs: Int!,
  $name: String!,
  $poolId: String!
) {
  createPoolDelegationAccessCondition(
    minDelegation: $minDelegation,
    minEpochs: $minEpochs,
    name: $name,
    poolId: $poolId
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "minDelegation": 123,
  "minEpochs": 987,
  "name": "abc123",
  "poolId": "abc123"
}

Response

{
  "data": {
    "createPoolDelegationAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": 4,
      "name": "abc123",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`createSession`

Response

Returns a Session!

Arguments

Name	Description
`address` - `String!`
`key` - `String!`
`signature` - `String!`

Example

Query

mutation createSession(
  $address: String!,
  $key: String!,
  $signature: String!
) {
  createSession(
    address: $address,
    key: $key,
    signature: $signature
  ) {
    id
    lifetime
    token
    user {
      ...UserFragment
    }
    userId
  }
}

Variables

{
  "address": "abc123",
  "key": "xyz789",
  "signature": "abc123"
}

Response

{
  "data": {
    "createSession": {
      "id": "4",
      "lifetime": "2007-12-03T10:15:30Z",
      "token": "abc123",
      "user": User,
      "userId": "xyz789"
    }
  }
}

Mutations

`createSpace`

Response

Returns a Space!

Arguments

Name	Description
`description` - `String`
`isActive` - `Boolean`	Default = `true`
`name` - `String!`
`slug` - `String!`

Example

Query

mutation createSpace(
  $description: String,
  $isActive: Boolean,
  $name: String!,
  $slug: String!
) {
  createSpace(
    description: $description,
    isActive: $isActive,
    name: $name,
    slug: $slug
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{
  "description": "xyz789",
  "isActive": true,
  "name": "abc123",
  "slug": "abc123"
}

Response

{
  "data": {
    "createSpace": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "xyz789",
      "download": [DecryptedFile],
      "files": [File],
      "id": 4,
      "isActive": false,
      "name": "xyz789",
      "slug": "xyz789",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`createUser`

Response

Returns a User!

Arguments

Name	Description
`address` - `String!`

Example

Query

mutation createUser($address: String!) {
  createUser(address: $address) {
    cardanoAddress
    id
    spaces {
      ...SpaceFragment
    }
  }
}

Variables

{"address": "xyz789"}

Response

{
  "data": {
    "createUser": {
      "cardanoAddress": "xyz789",
      "id": 4,
      "spaces": [Space]
    }
  }
}

Mutations

`createWhitelistAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`allow` - `[String!]!`
`name` - `String!`

Example

Query

mutation createWhitelistAccessCondition(
  $allow: [String!]!,
  $name: String!
) {
  createWhitelistAccessCondition(
    allow: $allow,
    name: $name
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "allow": ["xyz789"],
  "name": "xyz789"
}

Response

{
  "data": {
    "createWhitelistAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`deleteAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation deleteAccessCondition($id: String!) {
  deleteAccessCondition(id: $id) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "deleteAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "id": "4",
      "name": "abc123",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`deleteFile`

Response

Returns a File!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation deleteFile($id: String!) {
  deleteFile(id: $id) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "deleteFile": {
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": 4,
      "mime": "xyz789",
      "name": "xyz789",
      "space": Space,
      "spaceId": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`deleteForm`

Response

Returns a Form!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation deleteForm($id: String!) {
  deleteForm(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "deleteForm": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "xyz789",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": 4,
      "isActive": true,
      "name": "abc123",
      "slug": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`deleteSpace`

Response

Returns a Space!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation deleteSpace($id: String!) {
  deleteSpace(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "deleteSpace": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "xyz789",
      "download": [DecryptedFile],
      "files": [File],
      "id": "4",
      "isActive": false,
      "name": "abc123",
      "slug": "abc123",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`duplicateAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation duplicateAccessCondition($id: String!) {
  duplicateAccessCondition(id: $id) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "duplicateAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`duplicateForm`

Response

Returns a Form!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation duplicateForm($id: String!) {
  duplicateForm(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "duplicateForm": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "xyz789",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": "4",
      "isActive": false,
      "name": "abc123",
      "slug": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`duplicateSpace`

Response

Returns a Space!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation duplicateSpace($id: String!) {
  duplicateSpace(id: $id) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "duplicateSpace": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "abc123",
      "download": [DecryptedFile],
      "files": [File],
      "id": "4",
      "isActive": false,
      "name": "xyz789",
      "slug": "xyz789",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`extendSession`

Response

Returns a Session!

Example

Query

mutation extendSession {
  extendSession {
    id
    lifetime
    token
    user {
      ...UserFragment
    }
    userId
  }
}

Response

{
  "data": {
    "extendSession": {
      "id": "4",
      "lifetime": "2007-12-03T10:15:30Z",
      "token": "abc123",
      "user": User,
      "userId": "xyz789"
    }
  }
}

Mutations

`formLinkAccessCondition`

Response

Returns a FormAccessCondition!

Arguments

Name	Description
`accessConditionId` - `String!`
`formId` - `String!`

Example

Query

mutation formLinkAccessCondition(
  $accessConditionId: String!,
  $formId: String!
) {
  formLinkAccessCondition(
    accessConditionId: $accessConditionId,
    formId: $formId
  ) {
    accessCondition {
      ...AccessConditionFragment
    }
    form {
      ...FormFragment
    }
    id
  }
}

Variables

{
  "accessConditionId": "xyz789",
  "formId": "abc123"
}

Response

{
  "data": {
    "formLinkAccessCondition": {
      "accessCondition": AccessCondition,
      "form": Form,
      "id": 4
    }
  }
}

Mutations

`formUnlinkAccessCondition`

Response

Returns a FormAccessCondition!

Arguments

Name	Description
`accessConditionId` - `String!`
`formId` - `String!`

Example

Query

mutation formUnlinkAccessCondition(
  $accessConditionId: String!,
  $formId: String!
) {
  formUnlinkAccessCondition(
    accessConditionId: $accessConditionId,
    formId: $formId
  ) {
    accessCondition {
      ...AccessConditionFragment
    }
    form {
      ...FormFragment
    }
    id
  }
}

Variables

{
  "accessConditionId": "abc123",
  "formId": "xyz789"
}

Response

{
  "data": {
    "formUnlinkAccessCondition": {
      "accessCondition": AccessCondition,
      "form": Form,
      "id": "4"
    }
  }
}

Mutations

`registerInteraction`

Response

Returns an Interaction!

Arguments

Name	Description
`action` - `InteractionActionType!`
`event` - `JSONObject!`
`topic` - `String!`

Example

Query

mutation registerInteraction(
  $action: InteractionActionType!,
  $event: JSONObject!,
  $topic: String!
) {
  registerInteraction(
    action: $action,
    event: $event,
    topic: $topic
  ) {
    action
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    event
    id
    topic
  }
}

Variables

{
  "action": "CREATE",
  "event": {},
  "topic": "abc123"
}

Response

{
  "data": {
    "registerInteraction": {
      "action": "CREATE",
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "event": {},
      "id": 4,
      "topic": "xyz789"
    }
  }
}

Mutations

`spaceLinkAccessCondition`

Response

Returns a SpaceAccessCondition!

Arguments

Name	Description
`accessConditionId` - `String!`
`spaceId` - `String!`

Example

Query

mutation spaceLinkAccessCondition(
  $accessConditionId: String!,
  $spaceId: String!
) {
  spaceLinkAccessCondition(
    accessConditionId: $accessConditionId,
    spaceId: $spaceId
  ) {
    accessCondition {
      ...AccessConditionFragment
    }
    id
    space {
      ...SpaceFragment
    }
  }
}

Variables

{
  "accessConditionId": "abc123",
  "spaceId": "abc123"
}

Response

{
  "data": {
    "spaceLinkAccessCondition": {
      "accessCondition": AccessCondition,
      "id": 4,
      "space": Space
    }
  }
}

Mutations

`spaceUnlinkAccessCondition`

Response

Returns a SpaceAccessCondition!

Arguments

Name	Description
`accessConditionId` - `String!`
`spaceId` - `String!`

Example

Query

mutation spaceUnlinkAccessCondition(
  $accessConditionId: String!,
  $spaceId: String!
) {
  spaceUnlinkAccessCondition(
    accessConditionId: $accessConditionId,
    spaceId: $spaceId
  ) {
    accessCondition {
      ...AccessConditionFragment
    }
    id
    space {
      ...SpaceFragment
    }
  }
}

Variables

{
  "accessConditionId": "abc123",
  "spaceId": "xyz789"
}

Response

{
  "data": {
    "spaceUnlinkAccessCondition": {
      "accessCondition": AccessCondition,
      "id": 4,
      "space": Space
    }
  }
}

Mutations

`updateAssetOwnerAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`assetFingerprints` - `[String!]`
`id` - `String!`
`minAmount` - `Int`
`name` - `String`
`policyId` - `String`

Example

Query

mutation updateAssetOwnerAccessCondition(
  $assetFingerprints: [String!],
  $id: String!,
  $minAmount: Int,
  $name: String,
  $policyId: String
) {
  updateAssetOwnerAccessCondition(
    assetFingerprints: $assetFingerprints,
    id: $id,
    minAmount: $minAmount,
    name: $name,
    policyId: $policyId
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "assetFingerprints": ["abc123"],
  "id": "abc123",
  "minAmount": 123,
  "name": "xyz789",
  "policyId": "abc123"
}

Response

{
  "data": {
    "updateAssetOwnerAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`updateFile`

Response

Returns a File!

Arguments

Name	Description
`id` - `String!`
`name` - `String`

Example

Query

mutation updateFile(
  $id: String!,
  $name: String
) {
  updateFile(
    id: $id,
    name: $name
  ) {
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    mime
    name
    space {
      ...SpaceFragment
    }
    spaceId
    updatedAt
  }
}

Variables

{
  "id": "xyz789",
  "name": "xyz789"
}

Response

{
  "data": {
    "updateFile": {
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": "4",
      "mime": "abc123",
      "name": "xyz789",
      "space": Space,
      "spaceId": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`updateForm`

Response

Returns a Form!

Arguments

Name	Description
`description` - `String`
`fields` - `[FormFieldInput!]`
`id` - `String!`
`isActive` - `Boolean`
`name` - `String`
`slug` - `String`

Example

Query

mutation updateForm(
  $description: String,
  $fields: [FormFieldInput!],
  $id: String!,
  $isActive: Boolean,
  $name: String,
  $slug: String
) {
  updateForm(
    description: $description,
    fields: $fields,
    id: $id,
    isActive: $isActive,
    name: $name,
    slug: $slug
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{
  "description": "xyz789",
  "fields": [FormFieldInput],
  "id": "abc123",
  "isActive": true,
  "name": "xyz789",
  "slug": "abc123"
}

Response

{
  "data": {
    "updateForm": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "abc123",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": 4,
      "isActive": true,
      "name": "abc123",
      "slug": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`updateFormBranding`

Response

Returns a Form!

Arguments

Name	Description
`backgroundColor` - `String`
`discord` - `String`
`failureCallToActionButtonText` - `String`
`failureCallToActionText` - `String`
`failureCallToActionURL` - `String`
`fontColor` - `String`
`fontFamily` - `String`
`id` - `String!`
`logoFileContent` - `String`
`logoFileMime` - `String`
`logoFileName` - `String`
`primaryColor` - `String`
`secondaryColor` - `String`
`secondaryFailureCallToActionButtonText` - `String`
`secondaryFailureCallToActionURL` - `String`
`secondarySuccessCallToActionButtonText` - `String`
`secondarySuccessCallToActionURL` - `String`
`successCallToActionButtonText` - `String`
`successCallToActionText` - `String`
`successCallToActionURL` - `String`
`telegram` - `String`
`websiteURL` - `String`
`x` - `String`
`youtube` - `String`

Example

Query

mutation updateFormBranding(
  $backgroundColor: String,
  $discord: String,
  $failureCallToActionButtonText: String,
  $failureCallToActionText: String,
  $failureCallToActionURL: String,
  $fontColor: String,
  $fontFamily: String,
  $id: String!,
  $logoFileContent: String,
  $logoFileMime: String,
  $logoFileName: String,
  $primaryColor: String,
  $secondaryColor: String,
  $secondaryFailureCallToActionButtonText: String,
  $secondaryFailureCallToActionURL: String,
  $secondarySuccessCallToActionButtonText: String,
  $secondarySuccessCallToActionURL: String,
  $successCallToActionButtonText: String,
  $successCallToActionText: String,
  $successCallToActionURL: String,
  $telegram: String,
  $websiteURL: String,
  $x: String,
  $youtube: String
) {
  updateFormBranding(
    backgroundColor: $backgroundColor,
    discord: $discord,
    failureCallToActionButtonText: $failureCallToActionButtonText,
    failureCallToActionText: $failureCallToActionText,
    failureCallToActionURL: $failureCallToActionURL,
    fontColor: $fontColor,
    fontFamily: $fontFamily,
    id: $id,
    logoFileContent: $logoFileContent,
    logoFileMime: $logoFileMime,
    logoFileName: $logoFileName,
    primaryColor: $primaryColor,
    secondaryColor: $secondaryColor,
    secondaryFailureCallToActionButtonText: $secondaryFailureCallToActionButtonText,
    secondaryFailureCallToActionURL: $secondaryFailureCallToActionURL,
    secondarySuccessCallToActionButtonText: $secondarySuccessCallToActionButtonText,
    secondarySuccessCallToActionURL: $secondarySuccessCallToActionURL,
    successCallToActionButtonText: $successCallToActionButtonText,
    successCallToActionText: $successCallToActionText,
    successCallToActionURL: $successCallToActionURL,
    telegram: $telegram,
    websiteURL: $websiteURL,
    x: $x,
    youtube: $youtube
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    fields {
      ...FormFieldFragment
    }
    formAccessConditions {
      ...FormAccessConditionFragment
    }
    id
    isActive
    name
    slug
    updatedAt
  }
}

Variables

{
  "backgroundColor": "abc123",
  "discord": "xyz789",
  "failureCallToActionButtonText": "abc123",
  "failureCallToActionText": "abc123",
  "failureCallToActionURL": "abc123",
  "fontColor": "abc123",
  "fontFamily": "xyz789",
  "id": "xyz789",
  "logoFileContent": "abc123",
  "logoFileMime": "abc123",
  "logoFileName": "abc123",
  "primaryColor": "abc123",
  "secondaryColor": "abc123",
  "secondaryFailureCallToActionButtonText": "xyz789",
  "secondaryFailureCallToActionURL": "xyz789",
  "secondarySuccessCallToActionButtonText": "abc123",
  "secondarySuccessCallToActionURL": "xyz789",
  "successCallToActionButtonText": "abc123",
  "successCallToActionText": "abc123",
  "successCallToActionURL": "xyz789",
  "telegram": "xyz789",
  "websiteURL": "abc123",
  "x": "xyz789",
  "youtube": "xyz789"
}

Response

{
  "data": {
    "updateFormBranding": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "abc123",
      "fields": [FormField],
      "formAccessConditions": [FormAccessCondition],
      "id": 4,
      "isActive": true,
      "name": "abc123",
      "slug": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`updatePoolDelegationAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`id` - `String!`
`minDelegation` - `Int`
`minEpochs` - `Int`
`name` - `String`
`poolId` - `String`

Example

Query

mutation updatePoolDelegationAccessCondition(
  $id: String!,
  $minDelegation: Int,
  $minEpochs: Int,
  $name: String,
  $poolId: String
) {
  updatePoolDelegationAccessCondition(
    id: $id,
    minDelegation: $minDelegation,
    minEpochs: $minEpochs,
    name: $name,
    poolId: $poolId
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "id": "xyz789",
  "minDelegation": 123,
  "minEpochs": 123,
  "name": "abc123",
  "poolId": "abc123"
}

Response

{
  "data": {
    "updatePoolDelegationAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "id": "4",
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Mutations

`updateSpace`

Response

Returns a Space!

Arguments

Name	Description
`description` - `String`
`id` - `String!`
`isActive` - `Boolean`
`name` - `String`
`slug` - `String`

Example

Query

mutation updateSpace(
  $description: String,
  $id: String!,
  $isActive: Boolean,
  $name: String,
  $slug: String
) {
  updateSpace(
    description: $description,
    id: $id,
    isActive: $isActive,
    name: $name,
    slug: $slug
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{
  "description": "xyz789",
  "id": "abc123",
  "isActive": true,
  "name": "abc123",
  "slug": "xyz789"
}

Response

{
  "data": {
    "updateSpace": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "abc123",
      "description": "xyz789",
      "download": [DecryptedFile],
      "files": [File],
      "id": "4",
      "isActive": true,
      "name": "abc123",
      "slug": "xyz789",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`updateSpaceBranding`

Response

Returns a Space!

Arguments

Name	Description
`backgroundColor` - `String`
`discord` - `String`
`failureCallToActionButtonText` - `String`
`failureCallToActionText` - `String`
`failureCallToActionURL` - `String`
`fontColor` - `String`
`fontFamily` - `String`
`id` - `String!`
`logoFileContent` - `String`
`logoFileMime` - `String`
`logoFileName` - `String`
`primaryColor` - `String`
`secondaryColor` - `String`
`secondaryFailureCallToActionButtonText` - `String`
`secondaryFailureCallToActionURL` - `String`
`secondarySuccessCallToActionButtonText` - `String`
`secondarySuccessCallToActionURL` - `String`
`successCallToActionButtonText` - `String`
`successCallToActionText` - `String`
`successCallToActionURL` - `String`
`telegram` - `String`
`websiteURL` - `String`
`x` - `String`
`youtube` - `String`

Example

Query

mutation updateSpaceBranding(
  $backgroundColor: String,
  $discord: String,
  $failureCallToActionButtonText: String,
  $failureCallToActionText: String,
  $failureCallToActionURL: String,
  $fontColor: String,
  $fontFamily: String,
  $id: String!,
  $logoFileContent: String,
  $logoFileMime: String,
  $logoFileName: String,
  $primaryColor: String,
  $secondaryColor: String,
  $secondaryFailureCallToActionButtonText: String,
  $secondaryFailureCallToActionURL: String,
  $secondarySuccessCallToActionButtonText: String,
  $secondarySuccessCallToActionURL: String,
  $successCallToActionButtonText: String,
  $successCallToActionText: String,
  $successCallToActionURL: String,
  $telegram: String,
  $websiteURL: String,
  $x: String,
  $youtube: String
) {
  updateSpaceBranding(
    backgroundColor: $backgroundColor,
    discord: $discord,
    failureCallToActionButtonText: $failureCallToActionButtonText,
    failureCallToActionText: $failureCallToActionText,
    failureCallToActionURL: $failureCallToActionURL,
    fontColor: $fontColor,
    fontFamily: $fontFamily,
    id: $id,
    logoFileContent: $logoFileContent,
    logoFileMime: $logoFileMime,
    logoFileName: $logoFileName,
    primaryColor: $primaryColor,
    secondaryColor: $secondaryColor,
    secondaryFailureCallToActionButtonText: $secondaryFailureCallToActionButtonText,
    secondaryFailureCallToActionURL: $secondaryFailureCallToActionURL,
    secondarySuccessCallToActionButtonText: $secondarySuccessCallToActionButtonText,
    secondarySuccessCallToActionURL: $secondarySuccessCallToActionURL,
    successCallToActionButtonText: $successCallToActionButtonText,
    successCallToActionText: $successCallToActionText,
    successCallToActionURL: $successCallToActionURL,
    telegram: $telegram,
    websiteURL: $websiteURL,
    x: $x,
    youtube: $youtube
  ) {
    activeSince
    branding {
      ...BrandingSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    description
    download {
      ...DecryptedFileFragment
    }
    files {
      ...FileFragment
    }
    id
    isActive
    name
    slug
    spaceAccessConditions {
      ...SpaceAccessConditionFragment
    }
    updatedAt
  }
}

Variables

{
  "backgroundColor": "abc123",
  "discord": "xyz789",
  "failureCallToActionButtonText": "abc123",
  "failureCallToActionText": "abc123",
  "failureCallToActionURL": "xyz789",
  "fontColor": "xyz789",
  "fontFamily": "xyz789",
  "id": "abc123",
  "logoFileContent": "xyz789",
  "logoFileMime": "xyz789",
  "logoFileName": "abc123",
  "primaryColor": "xyz789",
  "secondaryColor": "abc123",
  "secondaryFailureCallToActionButtonText": "abc123",
  "secondaryFailureCallToActionURL": "xyz789",
  "secondarySuccessCallToActionButtonText": "abc123",
  "secondarySuccessCallToActionURL": "xyz789",
  "successCallToActionButtonText": "abc123",
  "successCallToActionText": "abc123",
  "successCallToActionURL": "abc123",
  "telegram": "abc123",
  "websiteURL": "abc123",
  "x": "xyz789",
  "youtube": "abc123"
}

Response

{
  "data": {
    "updateSpaceBranding": {
      "activeSince": "2007-12-03T10:15:30Z",
      "branding": BrandingSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "description": "xyz789",
      "download": [DecryptedFile],
      "files": [File],
      "id": "4",
      "isActive": true,
      "name": "abc123",
      "slug": "xyz789",
      "spaceAccessConditions": [SpaceAccessCondition],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`updateWhitelistAccessCondition`

Response

Returns an AccessCondition!

Arguments

Name	Description
`allow` - `[String!]`
`id` - `String!`
`name` - `String`

Example

Query

mutation updateWhitelistAccessCondition(
  $allow: [String!],
  $id: String!,
  $name: String
) {
  updateWhitelistAccessCondition(
    allow: $allow,
    id: $id,
    name: $name
  ) {
    assetOwnerSettings {
      ...AccessConditionAssetOwnerSettingsFragment
    }
    createdAt
    creator {
      ...UserFragment
    }
    creatorId
    id
    name
    poolDelegationSettings {
      ...AccessConditionPoolDelegationSettingsFragment
    }
    type
    updatedAt
    whitelistSettings {
      ...AccessConditionWhitelistSettingsFragment
    }
  }
}

Variables

{
  "allow": ["abc123"],
  "id": "xyz789",
  "name": "xyz789"
}

Response

{
  "data": {
    "updateWhitelistAccessCondition": {
      "assetOwnerSettings": AccessConditionAssetOwnerSettings,
      "createdAt": "2007-12-03T10:15:30Z",
      "creator": User,
      "creatorId": "xyz789",
      "id": 4,
      "name": "xyz789",
      "poolDelegationSettings": AccessConditionPoolDelegationSettings,
      "type": "ASSET_OWNER",
      "updatedAt": "2007-12-03T10:15:30Z",
      "whitelistSettings": AccessConditionWhitelistSettings
    }
  }
}

Types

AccessCondition

Fields

Field Name	Description
`assetOwnerSettings` - `AccessConditionAssetOwnerSettings`
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`id` - `ID!`
`name` - `String!`
`poolDelegationSettings` - `AccessConditionPoolDelegationSettings`
`type` - `AccessConditionType!`
`updatedAt` - `DateTime!`
`whitelistSettings` - `AccessConditionWhitelistSettings`

Example

{
  "assetOwnerSettings": AccessConditionAssetOwnerSettings,
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "abc123",
  "id": "4",
  "name": "abc123",
  "poolDelegationSettings": AccessConditionPoolDelegationSettings,
  "type": "ASSET_OWNER",
  "updatedAt": "2007-12-03T10:15:30Z",
  "whitelistSettings": AccessConditionWhitelistSettings
}

Types

AccessConditionAssetOwnerSettings

Fields

Field Name	Description
`assetFingerprints` - `[String!]!`
`minAmount` - `Int!`
`policyId` - `String!`

Example

{
  "assetFingerprints": ["xyz789"],
  "minAmount": 987,
  "policyId": "abc123"
}

Types

AccessConditionPoolDelegationSettings

Fields

Field Name	Description
`minDelegation` - `Int!`
`minEpochs` - `Int!`
`poolId` - `String!`

Example

{
  "minDelegation": 987,
  "minEpochs": 987,
  "poolId": "abc123"
}

Types

AccessConditionType

Values

Enum Value	Description
`ASSET_OWNER`
`POOL_DELEGATION`
`WHITELIST`

Example

"ASSET_OWNER"

Types

AccessConditionWhitelistSettings

Fields

Field Name	Description
`allow` - `[String!]!`

Example

{"allow": ["xyz789"]}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BrandingSettings

Fields

Field Name	Description
`backgroundColor` - `String`
`discord` - `String`
`failureCallToActionButtonText` - `String`
`failureCallToActionText` - `String`
`failureCallToActionURL` - `String`
`fontColor` - `String`
`fontFamily` - `String`
`logoFileContent` - `String`
`logoFileMime` - `String`
`logoFileName` - `String`
`primaryColor` - `String`
`secondaryColor` - `String`
`secondaryFailureCallToActionButtonText` - `String`
`secondaryFailureCallToActionURL` - `String`
`secondarySuccessCallToActionButtonText` - `String`
`secondarySuccessCallToActionURL` - `String`
`successCallToActionButtonText` - `String`
`successCallToActionText` - `String`
`successCallToActionURL` - `String`
`telegram` - `String`
`websiteURL` - `String`
`x` - `String`
`youtube` - `String`

Example

{
  "backgroundColor": "xyz789",
  "discord": "abc123",
  "failureCallToActionButtonText": "abc123",
  "failureCallToActionText": "xyz789",
  "failureCallToActionURL": "xyz789",
  "fontColor": "abc123",
  "fontFamily": "xyz789",
  "logoFileContent": "abc123",
  "logoFileMime": "abc123",
  "logoFileName": "xyz789",
  "primaryColor": "xyz789",
  "secondaryColor": "abc123",
  "secondaryFailureCallToActionButtonText": "abc123",
  "secondaryFailureCallToActionURL": "abc123",
  "secondarySuccessCallToActionButtonText": "abc123",
  "secondarySuccessCallToActionURL": "abc123",
  "successCallToActionButtonText": "xyz789",
  "successCallToActionText": "abc123",
  "successCallToActionURL": "xyz789",
  "telegram": "xyz789",
  "websiteURL": "abc123",
  "x": "abc123",
  "youtube": "abc123"
}

Types

CheckFormAccessResult

Fields

Field Name	Description
`hasAccess` - `Boolean!`

Example

{"hasAccess": true}

Types

CheckSpaceAccessResult

Fields

Field Name	Description
`hasAccess` - `Boolean!`

Example

{"hasAccess": false}

Types

DashboardKeyMetric

Fields

Field Name	Description
`ctaEngagement` - `Float!`
`totalConnectedWallets` - `Int!`
`totalForms` - `Int!`
`totalInteractions` - `Int!`
`totalSpaces` - `Int!`
`totalUniqueEntries` - `Int!`
`totalUnlocks` - `Int!`

Example

{
  "ctaEngagement": 123.45,
  "totalConnectedWallets": 987,
  "totalForms": 987,
  "totalInteractions": 123,
  "totalSpaces": 123,
  "totalUniqueEntries": 987,
  "totalUnlocks": 987
}

Types

DateTime

Description

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example

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

Types

DecryptedFile

Fields

Field Name	Description
`content` - `String!`
`id` - `String!`
`mime` - `String!`
`name` - `String!`

Example

{
  "content": "abc123",
  "id": "xyz789",
  "mime": "abc123",
  "name": "xyz789"
}

Types

DistributionEngagementCTAMetric

Fields

Field Name	Description
`fallbackCTA` - `Float!`
`successCTA` - `Float!`

Example

{"fallbackCTA": 123.45, "successCTA": 123.45}

Types

FallbackFunnelMetric

Fields

Field Name	Description
`fallbackCTA` - `Int!`
`unsuccessUnlocks` - `Int!`
`views` - `Int!`

Example

{"fallbackCTA": 123, "unsuccessUnlocks": 987, "views": 123}

Types

File

Description

The File object represents a stored data object with a unique name and encrypted content. The content can be decrypted and downloaded.

Fields

Field Name	Description
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`id` - `ID!`
`mime` - `String!`	Mime type of the file
`name` - `String!`	Name of the file including extension if any
`space` - `Space!`
`spaceId` - `String!`
`updatedAt` - `DateTime!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "abc123",
  "id": 4,
  "mime": "abc123",
  "name": "xyz789",
  "space": Space,
  "spaceId": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

Form

Fields

Field Name	Description
`activeSince` - `DateTime!`
`branding` - `BrandingSettings`
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`description` - `String!`	Description of the form
`fields` - `[FormField!]!`
`formAccessConditions` - `[FormAccessCondition!]!`	AccessConditions used for authenticate users to the form
`id` - `ID!`
`isActive` - `Boolean!`
`name` - `String!`	Name of the form
`slug` - `String!`
`updatedAt` - `DateTime!`

Example

{
  "activeSince": "2007-12-03T10:15:30Z",
  "branding": BrandingSettings,
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "xyz789",
  "description": "abc123",
  "fields": [FormField],
  "formAccessConditions": [FormAccessCondition],
  "id": 4,
  "isActive": true,
  "name": "xyz789",
  "slug": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

FormAccessCondition

Fields

Field Name	Description
`accessCondition` - `AccessCondition!`
`form` - `Form!`
`id` - `ID!`

Example

{
  "accessCondition": AccessCondition,
  "form": Form,
  "id": "4"
}

Types

FormEntry

Fields

Field Name	Description
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`form` - `Form`
`formId` - `String`
`id` - `ID!`
`stakeKey` - `String`
`updatedAt` - `DateTime!`
`values` - `JSONObject!`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "abc123",
  "form": Form,
  "formId": "xyz789",
  "id": 4,
  "stakeKey": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "values": {}
}

Types

FormField

Fields

Field Name	Description
`key` - `String!`
`options` - `[String!]!`
`required` - `Boolean!`
`text` - `String!`
`type` - `FormFieldTypes!`

Example

{
  "key": "xyz789",
  "options": ["abc123"],
  "required": true,
  "text": "xyz789",
  "type": "ADDRESS"
}

Types

FormFieldInput

Fields

Input Field	Description
`key` - `String!`
`options` - `[String!]`
`required` - `Boolean!`
`text` - `String!`
`type` - `FormFieldTypes!`

Example

{
  "key": "abc123",
  "options": ["xyz789"],
  "required": true,
  "text": "abc123",
  "type": "ADDRESS"
}

Types

FormFieldTypes

Values

Enum Value	Description
`ADDRESS`
`DATE`
`EMAIL`
`LONG_TEXT`
`PHONE`
`SELECTION`
`TEXT`

Example

"ADDRESS"

Types

FormMetric

Fields

Field Name	Description
`formId` - `String!`
`formName` - `String!`
`unlocks` - `Int!`

Example

{
  "formId": "abc123",
  "formName": "abc123",
  "unlocks": 123
}

Types

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

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

Types

Interaction

Fields

Field Name	Description
`action` - `InteractionActionType!`
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`event` - `JSONObject!`
`id` - `ID!`
`topic` - `String!`

Example

{
  "action": "CREATE",
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "xyz789",
  "event": {},
  "id": 4,
  "topic": "xyz789"
}

Types

InteractionActionType

Values

Enum Value	Description
`CREATE`
`DELETE`
`READ`
`UPDATE`

Example

"CREATE"

Types

JSONObject

Description

The JSONObject scalar type represents JSON objects as specified by ECMA-404.

Example

{}

Types

Session

Fields

Field Name	Description
`id` - `ID!`
`lifetime` - `DateTime!`	Date when the token expires
`token` - `String!`	Token identifying this session
`user` - `User!`
`userId` - `String!`

Example

{
  "id": 4,
  "lifetime": "2007-12-03T10:15:30Z",
  "token": "abc123",
  "user": User,
  "userId": "abc123"
}

Types

SignatureChallengeResponse

Fields

Field Name	Description
`message` - `String!`

Example

{"message": "xyz789"}

Types

Space

Fields

Field Name	Description
`activeSince` - `DateTime!`
`branding` - `BrandingSettings`
`createdAt` - `DateTime!`
`creator` - `User!`
`creatorId` - `String!`
`description` - `String!`	Description of the space
`download` - `[DecryptedFile!]!`
`files` - `[File!]!`	Files linked the space
`id` - `ID!`
`isActive` - `Boolean!`
`name` - `String!`	Name of the space
`slug` - `String!`
`spaceAccessConditions` - `[SpaceAccessCondition!]!`	AccessConditions used for authenticate users to the space
`updatedAt` - `DateTime!`

Example

{
  "activeSince": "2007-12-03T10:15:30Z",
  "branding": BrandingSettings,
  "createdAt": "2007-12-03T10:15:30Z",
  "creator": User,
  "creatorId": "abc123",
  "description": "xyz789",
  "download": [DecryptedFile],
  "files": [File],
  "id": "4",
  "isActive": false,
  "name": "xyz789",
  "slug": "abc123",
  "spaceAccessConditions": [SpaceAccessCondition],
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

SpaceAccessCondition

Fields

Field Name	Description
`accessCondition` - `AccessCondition!`
`id` - `ID!`
`space` - `Space!`

Example

{
  "accessCondition": AccessCondition,
  "id": "4",
  "space": Space
}

Types

SpaceMetric

Fields

Field Name	Description
`spaceId` - `String!`
`spaceName` - `String!`
`unlocks` - `Int!`

Example

{
  "spaceId": "abc123",
  "spaceName": "abc123",
  "unlocks": 123
}

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

SuccessFunnelMetric

Fields

Field Name	Description
`successCTA` - `Int!`
`successUnlocks` - `Int!`
`views` - `Int!`

Example

{"successCTA": 987, "successUnlocks": 987, "views": 123}

Types

TrendingSpaceMetric

Fields

Field Name	Description
`interactions` - `Int!`
`spaceId` - `String!`
`spaceName` - `String!`
`unlocks` - `Int!`
`users` - `Int!`

Example

{
  "interactions": 123,
  "spaceId": "xyz789",
  "spaceName": "xyz789",
  "unlocks": 123,
  "users": 123
}

Types

TrendingSpacesMetric

Fields

Field Name	Description
`spaces` - `[TrendingSpaceMetric!]!`	metrics per space

Example

{"spaces": [TrendingSpaceMetric]}

Types

UnlocksPerFormMetric

Fields

Field Name	Description
`forms` - `[FormMetric!]!`	metrics per form

Example

{"forms": [FormMetric]}

Types

UnlocksPerSpaceMetric

Fields

Field Name	Description
`spaces` - `[SpaceMetric!]!`	metrics per space

Example

{"spaces": [SpaceMetric]}

Types

User

Fields

Field Name	Description
`cardanoAddress` - `String!`
`id` - `ID!`
`spaces` - `[Space!]!`

Example

{
  "cardanoAddress": "xyz789",
  "id": "4",
  "spaces": [Space]
}

Documentation by Anvil SpectaQL