Planstack GraphQL API API Reference

This details the GraphQL API that powers Planstack. Users are welcome to create their own integrations based on this API.

Authentication

In order to query or make mutations against the Planstack GraphQL API, you will need to authenticate yourself.

OAuth2 In order to create a new OAuth2 application with Planstack, you must email hello@planstack.io with an explanation of your application. If approved, we will issue a client id and secret that you will use. We issue standard bearer and refresh tokens. You will be given more detailed instructions upon acceptance.

API Endpoints
Production:
https://api.planstack.io/query

Queries

Queries consist of the various requests for data you can make against the Planstack API.

Me

See general information about the currently authenticated user.

Example

Request Content-Types: application/json
Query
query me{
  me{
    id
    email
    firstName
    lastName
    passwordLastUpdatedAt
    hasTfa
    avatar
    emailPendingVerification
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "me": {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "hasTfa": "boolean",
      "avatar": "string",
      "emailPendingVerification": "string"
    }
  }
}

Get Entry

Get an individual entry's details.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query entry($id: ID!){
  entry(id: $id){
    id
    createdAt
    updatedAt
    title
    description
    body
  }
}
Variables
{
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "entry": {
      "id": "string",
      "title": "string",
      "description": "string",
      "body": "string"
    }
  }
}

Get Organization

Get an individual organization's details.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query organization($id: ID!){
  organization(id: $id){
    id
    name
    billingEmail
    taxId
    taxIdType
  }
}
Variables
{
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "organization": {
      "id": "string",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string"
    }
  }
}

Get Workspace

Get an individual workspace's details.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query workspace($id: ID!){
  workspace(id: $id){
    id
    createdAt
    name
    description
  }
}
Variables
{
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "workspace": {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  }
}

Get View

Get an individual view's details.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query view($id: ID!){
  view(id: $id){
    id
    createdAt
    updatedAt
    name
    description
    color
    image
    dateWindow
    entryStyle
    showEntryCoverImages
  }
}
Variables
{
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "view": {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "string",
      "image": "string",
      "dateWindow": "string",
      "entryStyle": "string",
      "showEntryCoverImages": "boolean"
    }
  }
}

Mutations

Mutations consist of the various requests to modify Planstack data that you can make.

Add Property to Entry

Add a property value to an existing entry.

(no description)

Example

Request Content-Types: application/json
Query
mutation addPropertyToEntry($input: AddEntryProperty!){
  addPropertyToEntry(input: $input){
    id
    value
    order
  }
}
Variables
{
  "input": {
    "propertyId": "string",
    "entryId": "string",
    "kind": "string",
    "value": "object",
    "order": "number"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "addPropertyToEntry": {
      "id": "string",
      "order": "integer"
    }
  }
}

Add Display Properties to View

Set properties to show up on entry cards in a view.

viewId:
string

(no description)

propertyIds:
string[]

(no description)

Example

Request Content-Types: application/json
Query
mutation addPropertiesToView($viewId: String!, $propertyIds: [String!]){
  addPropertiesToView(viewId: $viewId, propertyIds: $propertyIds){
    id
    createdAt
    updatedAt
  }
}
Variables
{
  "viewId": "string",
  "propertyIds": [
    "string"
  ]
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "addPropertiesToView": [
      {
        "id": "string"
      }
    ]
  }
}

Clone Entry

Clone an entry.

entryId:
string

(no description)

newName:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation cloneEntry($entryId: String!, $newName: String){
  cloneEntry(entryId: $entryId, newName: $newName){
    id
    createdAt
    updatedAt
    title
    description
    body
  }
}
Variables
{
  "entryId": "string",
  "newName": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "cloneEntry": {
      "id": "string",
      "title": "string",
      "description": "string",
      "body": "string"
    }
  }
}

Clone View

Clone a view.

viewId:
string

(no description)

newName:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation cloneView($viewId: String!, $newName: String){
  cloneView(viewId: $viewId, newName: $newName){
    id
    createdAt
    updatedAt
    name
    description
    color
    image
    dateWindow
    entryStyle
    showEntryCoverImages
  }
}
Variables
{
  "viewId": "string",
  "newName": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "cloneView": {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "string",
      "image": "string",
      "dateWindow": "string",
      "entryStyle": "string",
      "showEntryCoverImages": "boolean"
    }
  }
}

Create Property

Create a property for a workspace.

property:

(no description)

Example

Request Content-Types: application/json
Query
mutation createProperty($property: NewProperty!){
  createProperty(property: $property){
    id
    createdAt
    updatedAt
    type
    kind
    name
    options
    description
  }
}
Variables
{
  "property": {
    "name": "string",
    "description": "string",
    "kind": "string",
    "options": "object",
    "workspaceId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createProperty": {
      "id": "string",
      "type": "string",
      "kind": "string",
      "name": "string",
      "description": "string"
    }
  }
}

Create Entry

Create a new entry.

entry:

(no description)

entryProperties:

(no description)

attachments:

(no description)

Example

Request Content-Types: application/json
Query
mutation createEntry($entry: NewEntry!, $entryProperties: [NewEntryProperty!], $attachments: [NewAttachment!]){
  createEntry(entry: $entry, entryProperties: $entryProperties, attachments: $attachments){
    id
    createdAt
    updatedAt
    title
    description
    body
  }
}
Variables
{
  "entry": {
    "title": "string",
    "description": "string",
    "body": "string",
    "workspaceId": "string"
  },
  "entryProperties": [
    {
      "propertyId": "string",
      "kind": "string",
      "value": "object",
      "order": "number"
    }
  ],
  "attachments": [
    {
      "name": "string",
      "description": "string",
      "file": "object"
    }
  ]
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createEntry": {
      "id": "string",
      "title": "string",
      "description": "string",
      "body": "string"
    }
  }
}

Create Organization

Create a new organization.

(no description)

Example

Request Content-Types: application/json
Query
mutation createOrganization($input: NewOrganization!){
  createOrganization(input: $input){
    id
    name
    billingEmail
    taxId
    taxIdType
  }
}
Variables
{
  "input": {
    "name": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createOrganization": {
      "id": "string",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string"
    }
  }
}

Create View

Create a new view.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createView($input: NewView!){
  createView(input: $input){
    id
    createdAt
    updatedAt
    name
    description
    color
    image
    dateWindow
    entryStyle
    showEntryCoverImages
  }
}
Variables
{
  "input": {
    "name": "string",
    "color": "string",
    "description": "string",
    "image": "object",
    "workspaceId": "string",
    "dateWindow": "string",
    "entryStyle": "string",
    "showEntryCoverImages": "boolean",
    "organizingDatePropertyId": "string",
    "organizingTaxonomyPropertyId": "string",
    "displayProperties": [
      "string"
    ],
    "filters": [
      {
        "viewId": "string",
        "propertyId": "string",
        "value": "object"
      }
    ]
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createView": {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "string",
      "image": "string",
      "dateWindow": "string",
      "entryStyle": "string",
      "showEntryCoverImages": "boolean"
    }
  }
}

Create Workspace

Create a new workspace.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createWorkspace($input: NewWorkspace!){
  createWorkspace(input: $input){
    id
    createdAt
    name
    description
  }
}
Variables
{
  "input": {
    "name": "string",
    "description": "string",
    "organizationId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createWorkspace": {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  }
}

Delete Entry

Delete an entry.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteEntry($id: ID!){
  deleteEntry(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteEntry": "boolean"
  }
}

Delete Organization

Delete an organization.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteOrganization($id: ID!){
  deleteOrganization(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteOrganization": "boolean"
  }
}

Delete View

Delete a view.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteView($id: ID!){
  deleteView(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteView": "boolean"
  }
}

Delete Workspace

Delete a workspace.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteWorkspace($id: ID!){
  deleteWorkspace(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteWorkspace": "boolean"
  }
}

Delete Property

Delete a property. This can have consequences if views or entries depend on the property. Exercise caution.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteProperty($id: ID!){
  deleteProperty(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteProperty": "boolean"
  }
}

Remove Property from Entry

Remove a property value from an entry.

entryPropertyId:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation removePropertyFromEntry($entryPropertyId: ID!){
  removePropertyFromEntry(entryPropertyId: $entryPropertyId)
}
Variables
{
  "entryPropertyId": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "removePropertyFromEntry": "boolean"
  }
}

Remove Entry Attachment

Remove an attachment from an entry

id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteEntryAttachment($id: ID!){
  deleteEntryAttachment(id: $id)
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "deleteEntryAttachment": "boolean"
  }
}

Update Property

Update a property

id:
string

(no description)

(no description)

Example

Request Content-Types: application/json
Query
mutation updateProperty($id: ID!, $input: UpdateProperty!){
  updateProperty(id: $id, input: $input){
    id
    createdAt
    updatedAt
    type
    kind
    name
    options
    description
  }
}
Variables
{
  "id": "string",
  "input": {
    "name": "string",
    "description": "string",
    "kind": "string",
    "options": "object"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateProperty": {
      "id": "string",
      "type": "string",
      "kind": "string",
      "name": "string",
      "description": "string"
    }
  }
}

Update Entry

Update an entry.

id:
string

(no description)

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateEntry($id: ID!, $input: UpdateEntry!){
  updateEntry(id: $id, input: $input){
    id
    createdAt
    updatedAt
    title
    description
    body
  }
}
Variables
{
  "id": "string",
  "input": {
    "title": "string",
    "description": "string",
    "body": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateEntry": {
      "id": "string",
      "title": "string",
      "description": "string",
      "body": "string"
    }
  }
}

Update Entry Attachment

Update an entry attachment.

id:
string

(no description)

(no description)

Example

Request Content-Types: application/json
Query
mutation updateEntryAttachment($id: ID!, $input: UpdateEntryAttachment){
  updateEntryAttachment(id: $id, input: $input){
    id
    createdAt
    updatedAt
    isCoverImage
  }
}
Variables
{
  "id": "string",
  "input": {
    "isCoverImage": "boolean"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateEntryAttachment": {
      "id": "string",
      "isCoverImage": "boolean"
    }
  }
}

Update Entry Property

Update an entry property value.

id:
string

(no description)

(no description)

Example

Request Content-Types: application/json
Query
mutation updateEntryProperty($id: ID!, $input: UpdateEntryProperty!){
  updateEntryProperty(id: $id, input: $input){
    id
    value
    order
  }
}
Variables
{
  "id": "string",
  "input": {
    "value": "object",
    "kind": "string",
    "order": "number"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateEntryProperty": {
      "id": "string",
      "order": "integer"
    }
  }
}

Update View

Update a view.

id:
string

(no description)

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateView($id: ID!, $input: UpdateView!){
  updateView(id: $id, input: $input){
    id
    createdAt
    updatedAt
    name
    description
    color
    image
    dateWindow
    entryStyle
    showEntryCoverImages
  }
}
Variables
{
  "id": "string",
  "input": {
    "name": "string",
    "description": "string",
    "image": "object",
    "color": "string",
    "dateWindow": "string",
    "entryStyle": "string",
    "showEntryCoverImages": "boolean",
    "organizingDatePropertyId": "string",
    "organizingTaxonomyPropertyId": "string",
    "removeImage": "boolean",
    "displayProperties": [
      "string"
    ],
    "filters": [
      {
        "viewId": "string",
        "propertyId": "string",
        "value": "object"
      }
    ]
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateView": {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "string",
      "image": "string",
      "dateWindow": "string",
      "entryStyle": "string",
      "showEntryCoverImages": "boolean"
    }
  }
}

Update Workspace

Update a workspace.

id:
string

(no description)

(no description)

Example

Request Content-Types: application/json
Query
mutation updateWorkspace($id: ID!, $input: UpdateWorkspace!){
  updateWorkspace(id: $id, input: $input){
    id
    createdAt
    name
    description
  }
}
Variables
{
  "id": "string",
  "input": {
    "name": "string",
    "description": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "updateWorkspace": {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  }
}

Upload Entry Attachment

Upload a new attachment to an entry.

entryId:
string

(no description)

attachment:

(no description)

isCoverImage:
boolean

(no description)

Example

Request Content-Types: application/json
Query
mutation uploadEntryAttachment($entryId: String!, $attachment: NewAttachment!, $isCoverImage: Boolean){
  uploadEntryAttachment(entryId: $entryId, attachment: $attachment, isCoverImage: $isCoverImage){
    id
    createdAt
    updatedAt
    isCoverImage
  }
}
Variables
{
  "entryId": "string",
  "attachment": {
    "name": "string",
    "description": "string",
    "file": "object"
  },
  "isCoverImage": "boolean"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "uploadEntryAttachment": {
      "id": "string",
      "isCoverImage": "boolean"
    }
  }
}

Schema Definitions

AddEntryProperty: object

propertyId:
entryId:
kind:
value:
Any
order:
Int
Example
{
  "propertyId": "string",
  "entryId": "string",
  "kind": "string",
  "value": "object",
  "order": "number"
}

Address: object

city:
country:
line1:
line2:
postalCode:
state:
Example
{
  "city": "string",
  "country": "string",
  "line1": "string",
  "line2": "string",
  "postalCode": "string",
  "state": "string"
}

Any: object

Example
object

Attachment: object

id:
ID
createdAt:
updatedAt:
contentType:
description:
name:
location:
size:
Int
uploader:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "contentType": "string",
  "description": "string",
  "name": "string",
  "location": "string",
  "size": "number",
  "uploader": {
    "id": "object",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "organizations": [
      {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {}
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

AuthenticationPayload: object

userId:
accessToken:
refreshToken:
expiresAt:
Example
{
  "userId": "string",
  "accessToken": "string",
  "refreshToken": "string",
  "expiresAt": "object"
}

Boolean: boolean

The Boolean scalar type represents true or false.

Example
boolean

ChangePasswordInput: object

oldPassword:
newPassword:
Example
{
  "oldPassword": "string",
  "newPassword": "string"
}

Collaborator: object

id:
ID
createdAt:
user:
role:
Example
{
  "id": "object",
  "createdAt": "object",
  "user": {
    "id": "object",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "organizations": [
      {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object",
                          "name": "string",
                          "billingEmail": "string",
                          "taxId": "string",
                          "taxIdType": "string",
                          "workspaces": [
                            {}
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

CommunicationPreferences: object

productUpdates:
Example
{
  "productUpdates": "boolean"
}

DeleteAccountInput: object

password:
Example
{
  "password": "string"
}

Entry: object

id:
ID
createdAt:
updatedAt:
title:
description:
body:
workspace:
attachments:
properties:
coverImage:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "title": "string",
  "description": "string",
  "body": "string",
  "workspace": {
    "id": "object",
    "createdAt": "object",
    "name": "string",
    "description": "string",
    "organization": {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object",
                        "name": "string",
                        "billingEmail": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

EntryAttachment: object

id:
ID
createdAt:
updatedAt:
entry:
attachment:
isCoverImage:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "entry": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "title": "string",
    "description": "string",
    "body": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

EntryProperty: object

id:
ID
entry:
property:
value:
Any
order:
Int
Example
{
  "id": "object",
  "entry": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "title": "string",
    "description": "string",
    "body": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Float: number

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

Example
number

ForgotPasswordInput: object

email:
Example
{
  "email": "string"
}

ID: object

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
object

Int: number

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

Example
number

Invoice: object

id:
ID
currency:
periodStart:
periodEnd:
status:
total:
Int
downloadLink:
plan:
organizationId:
Example
{
  "id": "object",
  "currency": "string",
  "periodStart": "object",
  "periodEnd": "object",
  "status": "string",
  "total": "number",
  "downloadLink": "string",
  "plan": "string",
  "organizationId": "string"
}

LoginInput: object

email:
password:
otp:
recoveryCode:
Example
{
  "email": "string",
  "password": "string",
  "otp": "string",
  "recoveryCode": "string"
}

Map: object

Example
object

NewAttachment: object

name:
description:
file:
Example
{
  "name": "string",
  "description": "string",
  "file": "object"
}

NewEntry: object

title:
description:
body:
workspaceId:
Example
{
  "title": "string",
  "description": "string",
  "body": "string",
  "workspaceId": "string"
}

NewEntryProperty: object

propertyId:
kind:
value:
Any
order:
Int
Example
{
  "propertyId": "string",
  "kind": "string",
  "value": "object",
  "order": "number"
}

NewOrganization: object

name:
Example
{
  "name": "string"
}

NewProperty: object

name:
description:
kind:
options:
Any
workspaceId:
Example
{
  "name": "string",
  "description": "string",
  "kind": "string",
  "options": "object",
  "workspaceId": "string"
}

NewReadonlyViewToken: object

email:
password:
viewId:
Example
{
  "email": "string",
  "password": "string",
  "viewId": "string"
}

NewSubscription: object

users:
Int
productId:
organizationId:
priceId:
Example
{
  "users": "number",
  "productId": "string",
  "organizationId": "string",
  "priceId": "string"
}

NewTemplate: object

viewId:
image:
name:
description:
locale:
dynamicDates:
categories:
Example
{
  "viewId": "string",
  "image": "object",
  "name": "string",
  "description": "string",
  "locale": "string",
  "dynamicDates": "boolean",
  "categories": [
    "string"
  ]
}

NewUser: object

email:
password:
firstName:
lastName:
Example
{
  "email": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string"
}

NewUserSettings: object

locale:
timeZone:
theme:
Example
{
  "locale": "string",
  "timeZone": "string",
  "theme": "string"
}

NewView: object

name:
color:
description:
image:
workspaceId:
dateWindow:
entryStyle:
showEntryCoverImages:
organizingDatePropertyId:
organizingTaxonomyPropertyId:
displayProperties:
filters:
Example
{
  "name": "string",
  "color": "string",
  "description": "string",
  "image": "object",
  "workspaceId": "string",
  "dateWindow": "string",
  "entryStyle": "string",
  "showEntryCoverImages": "boolean",
  "organizingDatePropertyId": "string",
  "organizingTaxonomyPropertyId": "string",
  "displayProperties": [
    "string"
  ],
  "filters": [
    {
      "viewId": "string",
      "propertyId": "string",
      "value": "object"
    }
  ]
}

NewWebhookEndpoint: object

workspaceId:
url:
events:
signingSecret:
description:
Example
{
  "workspaceId": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "signingSecret": "boolean",
  "description": "string"
}

NewWorkspace: object

name:
description:
organizationId:
Example
{
  "name": "string",
  "description": "string",
  "organizationId": "string"
}

OAuth2Client: object

clientId:
redirectUri:
description:
name:
Example
{
  "clientId": "string",
  "redirectUri": "string",
  "description": "string",
  "name": "string"
}

Organization: object

id:
ID
name:
billingEmail:
taxId:
taxIdType:
workspaces:
collaborators:
properties:
branding:
Example
{
  "id": "object",
  "name": "string",
  "billingEmail": "string",
  "taxId": "string",
  "taxIdType": "string",
  "workspaces": [
    {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object",
                          "name": "string",
                          "billingEmail": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

OrganizationBranding: object

accents:
logo:
Example
{
  "accents": [
    "string"
  ],
  "logo": "string"
}

OrganizationInvitation: object

id:
ID
sent:
role:
email:
sender:
organization:
Example
{
  "id": "object",
  "sent": "object",
  "role": "string",
  "email": "string",
  "sender": {
    "id": "object",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "organizations": [
      {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object",
                          "name": "string",
                          "billingEmail": "string",
                          "taxId": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

OrganizationRole: object

organizationId:
role:
Example
{
  "organizationId": "string",
  "role": "string"
}

PaymentMethod: object

id:
type:
billingEmail:
billingPhone:
billingName:
billingAddress:
meta:
Map
Example
{
  "id": "string",
  "type": "string",
  "billingEmail": "string",
  "billingPhone": "string",
  "billingName": "string",
  "billingAddress": {
    "city": "string",
    "country": "string",
    "line1": "string",
    "line2": "string",
    "postalCode": "string",
    "state": "string"
  },
  "meta": "object"
}

Price: object

stripePriceId:
currency:
interval:
unitAmount:
Int
Example
{
  "stripePriceId": "string",
  "currency": "string",
  "interval": "string",
  "unitAmount": "number"
}

Product: object

id:
ID
active:
name:
prices:
Example
{
  "id": "object",
  "active": "boolean",
  "name": "string",
  "prices": [
    {
      "stripePriceId": "string",
      "currency": "string",
      "interval": "string",
      "unitAmount": "number"
    }
  ]
}

ProductSubscription: object

id:
ID
expiresAt:
users:
Int
product:
organization:
price:
paymentMethod:
status:
Example
{
  "id": "object",
  "expiresAt": "object",
  "users": "number",
  "product": {
    "id": "object",
    "active": "boolean",
    "name": "string",
    "prices": [
      {
        "stripePriceId": "string",
        "currency": "string",
        "interval": "string",
        "unitAmount": "number"
      }
    ]
  },
  "organization": {
    "id": "object",
    "name": "string",
    "billingEmail": "string",
    "taxId": "string",
    "taxIdType": "string",
    "workspaces": [
      {
        "id": "object",
        "createdAt": "object",
        "name": "string",
        "description": "string",
        "organization": {
          "id": "object",
          "name": "string",
          "billingEmail": "string",
          "taxId": "string",
          "taxIdType": "string",
          "workspaces": [
            {
              "id": "object",
              "createdAt": "object",
              "name": "string",
              "description": "string",
              "organization": {
                "id": "object",
                "name": "string",
                "billingEmail": "string",
                "taxId": "string",
                "taxIdType": "string",
                "workspaces": [
                  {
                    "id": "object",
                    "createdAt": "object",
                    "name": "string",
                    "description": "string",
                    "organization": {
                      "id": "object"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Property: object

id:
ID
createdAt:
updatedAt:
type:
kind:
name:
options:
Any
description:
workspace:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "type": "string",
  "kind": "string",
  "name": "string",
  "options": "object",
  "description": "string",
  "workspace": {
    "id": "object",
    "createdAt": "object",
    "name": "string",
    "description": "string",
    "organization": {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

ReadonlyEntry: object

id:
ID
createdAt:
updatedAt:
title:
description:
body:
workspace:
attachments:
properties:
coverImage:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "title": "string",
  "description": "string",
  "body": "string",
  "workspace": {
    "id": "object",
    "createdAt": "object",
    "name": "string",
    "description": "string",
    "organization": {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object",
                        "name": "string",
                        "billingEmail": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

ReadonlyEntryProperty: object

id:
ID
entryId:
property:
value:
Any
order:
Int
Example
{
  "id": "object",
  "entryId": "string",
  "property": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "type": "string",
    "kind": "string",
    "name": "string",
    "options": "object",
    "description": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ReadonlyView: object

id:
ID
name:
description:
workspaceName:
organizationName:
organizationBranding:
color:
image:
dateWindow:
entryStyle:
showEntryCoverImages:
organizingDateProperty:
organizingTaxonomyProperty:
properties:
entries:
collaborators:
Example
{
  "id": "object",
  "name": "string",
  "description": "string",
  "workspaceName": "string",
  "organizationName": "string",
  "organizationBranding": {
    "accents": [
      "string"
    ],
    "logo": "string"
  },
  "color": "string",
  "image": "string",
  "dateWindow": "string",
  "entryStyle": "string",
  "showEntryCoverImages": "boolean",
  "organizingDateProperty": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "type": "string",
    "kind": "string",
    "name": "string",
    "options": "object",
    "description": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ReadonlyViewToken: object

id:
ID
createdAt:
email:
code:
createdBy:
Example
{
  "id": "object",
  "createdAt": "object",
  "email": "string",
  "code": "string",
  "createdBy": {
    "id": "object",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "organizations": [
      {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object",
                          "name": "string",
                          "billingEmail": "string",
                          "taxId": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

ResetPasswordInput: object

password:
token:
Example
{
  "password": "string",
  "token": "string"
}

Roles: object

userId:
ID
role:
organizationRoles:
workspaceRoles:
allowedSubscriptions:
Example
{
  "userId": "object",
  "role": "string",
  "organizationRoles": [
    {
      "organizationId": "string",
      "role": "string"
    }
  ],
  "workspaceRoles": [
    {
      "organizationId": "string",
      "workspaceId": "string",
      "role": "string"
    }
  ],
  "allowedSubscriptions": [
    {
      "organizationId": "object",
      "valid": "boolean",
      "plan": "string"
    }
  ]
}

String: string

The Stringscalar 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.

SubscriptionValidity: object

organizationId:
ID
valid:
plan:
Example
{
  "organizationId": "object",
  "valid": "boolean",
  "plan": "string"
}

Template: object

id:
ID
name:
description:
locale:
image:
dynamicDates:
categories:
Example
{
  "id": "object",
  "name": "string",
  "description": "string",
  "locale": "string",
  "image": "string",
  "dynamicDates": "boolean",
  "categories": [
    "string"
  ]
}

Time: object

Example
object

UpdateCommunicationPreferences: object

productUpdates:
Example
{
  "productUpdates": "boolean"
}

UpdateEntry: object

title:
description:
body:
Example
{
  "title": "string",
  "description": "string",
  "body": "string"
}

UpdateEntryAttachment: object

isCoverImage:
Example
{
  "isCoverImage": "boolean"
}

UpdateEntryProperty: object

value:
Any
kind:
order:
Int
Example
{
  "value": "object",
  "kind": "string",
  "order": "number"
}

UpdateOrganization: object

name:
billingEmail:
taxId:
taxIdType:
Example
{
  "name": "string",
  "billingEmail": "string",
  "taxId": "string",
  "taxIdType": "string"
}

UpdateOrganizationBranding: object

accents:
logo:
removeLogo:
Example
{
  "accents": [
    "string"
  ],
  "logo": "object",
  "removeLogo": "boolean"
}

UpdateProductSubscription: object

priceId:
users:
Int
Example
{
  "priceId": "string",
  "users": "number"
}

UpdateProperty: object

name:
description:
kind:
options:
Any
Example
{
  "name": "string",
  "description": "string",
  "kind": "string",
  "options": "object"
}

UpdateUser: object

firstName:
lastName:
email:
password:
Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string"
}

UpdateUserSettings: object

locale:
timeZone:
theme:
defaultOrganizationId:
Example
{
  "locale": "string",
  "timeZone": "string",
  "theme": "string",
  "defaultOrganizationId": "string"
}

UpdateView: object

name:
description:
image:
color:
dateWindow:
entryStyle:
showEntryCoverImages:
organizingDatePropertyId:
organizingTaxonomyPropertyId:
removeImage:
displayProperties:
filters:
Example
{
  "name": "string",
  "description": "string",
  "image": "object",
  "color": "string",
  "dateWindow": "string",
  "entryStyle": "string",
  "showEntryCoverImages": "boolean",
  "organizingDatePropertyId": "string",
  "organizingTaxonomyPropertyId": "string",
  "removeImage": "boolean",
  "displayProperties": [
    "string"
  ],
  "filters": [
    {
      "viewId": "string",
      "propertyId": "string",
      "value": "object"
    }
  ]
}

UpdateWebhookEndpoint: object

url:
active:
events:
signingSecret:
description:
Example
{
  "url": "string",
  "active": "boolean",
  "events": [
    "string"
  ],
  "signingSecret": "boolean",
  "description": "string"
}

UpdateWorkspace: object

name:
description:
Example
{
  "name": "string",
  "description": "string"
}

Upload: object

Example
object

User: object

id:
ID
email:
firstName:
lastName:
organizations:
roles:
settings:
communicationPreferences:
passwordLastUpdatedAt:
hasTfa:
avatar:
emailPendingVerification:
Example
{
  "id": "object",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "organizations": [
    {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object",
                        "name": "string",
                        "billingEmail": "string",
                        "taxId": "string",
                        "taxIdType": "string",
                        "workspaces": [
                          {
                            "id": "object",
                            "createdAt": "object",
                            "name": "string"
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

UserSettings: object

locale:
timeZone:
theme:
defaultOrganizationId:
Example
{
  "locale": "string",
  "timeZone": "string",
  "theme": "string",
  "defaultOrganizationId": "string"
}

View: object

id:
ID
createdAt:
updatedAt:
name:
description:
color:
image:
workspace:
entries:
displayProperties:
dateWindow:
entryStyle:
showEntryCoverImages:
organizingDateProperty:
organizingTaxonomyProperty:
filters:
readonlyTokens:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "name": "string",
  "description": "string",
  "color": "string",
  "image": "string",
  "workspace": {
    "id": "object",
    "createdAt": "object",
    "name": "string",
    "description": "string",
    "organization": {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object",
                        "name": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

ViewFilter: object

id:
ID
createdAt:
updatedAt:
view:
property:
value:
Any
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "view": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "name": "string",
    "description": "string",
    "color": "string",
    "image": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ViewFilterOptions: object

viewId:
propertyId:
value:
Any
Example
{
  "viewId": "string",
  "propertyId": "string",
  "value": "object"
}

ViewProperty: object

id:
ID
createdAt:
updatedAt:
view:
property:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "view": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "name": "string",
    "description": "string",
    "color": "string",
    "image": "string",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

WebhookEndpoint: object

id:
ID
createdAt:
updatedAt:
workspace:
url:
active:
events:
signingSecret:
description:
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "workspace": {
    "id": "object",
    "createdAt": "object",
    "name": "string",
    "description": "string",
    "organization": {
      "id": "object",
      "name": "string",
      "billingEmail": "string",
      "taxId": "string",
      "taxIdType": "string",
      "workspaces": [
        {
          "id": "object",
          "createdAt": "object",
          "name": "string",
          "description": "string",
          "organization": {
            "id": "object",
            "name": "string",
            "billingEmail": "string",
            "taxId": "string",
            "taxIdType": "string",
            "workspaces": [
              {
                "id": "object",
                "createdAt": "object",
                "name": "string",
                "description": "string",
                "organization": {
                  "id": "object",
                  "name": "string",
                  "billingEmail": "string",
                  "taxId": "string",
                  "taxIdType": "string",
                  "workspaces": [
                    {
                      "id": "object",
                      "createdAt": "object",
                      "name": "string",
                      "description": "string",
                      "organization": {
                        "id": "object",
                        "name": "string",
                        "billingEmail": "string",
                        "taxId": "string",
                        "taxIdType": "string",
                        "workspaces": [
                          null
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

WebhookEvent: object

id:
ID
eventId:
createdAt:
updatedAt:
webhookEndpoint:
event:
success:
attempts:
Example
{
  "id": "object",
  "eventId": "string",
  "createdAt": "object",
  "updatedAt": "object",
  "webhookEndpoint": {
    "id": "object",
    "createdAt": "object",
    "updatedAt": "object",
    "workspace": {
      "id": "object",
      "createdAt": "object",
      "name": "string",
      "description": "string",
      "organization": {
        "id": "object",
        "name": "string",
        "billingEmail": "string",
        "taxId": "string",
        "taxIdType": "string",
        "workspaces": [
          {
            "id": "object",
            "createdAt": "object",
            "name": "string",
            "description": "string",
            "organization": {
              "id": "object",
              "name": "string",
              "billingEmail": "string",
              "taxId": "string",
              "taxIdType": "string",
              "workspaces": [
                {
                  "id": "object",
                  "createdAt": "object",
                  "name": "string",
                  "description": "string",
                  "organization": {
                    "id": "object",
                    "name": "string",
                    "billingEmail": "string",
                    "taxId": "string",
                    "taxIdType": "string",
                    "workspaces": [
                      {
                        "id": "object",
                        "createdAt": "object",
                        "name": "string",
                        "description": "string",
                        "organization": {
                          "id": "object"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

WebhookEventAttempt: object

id:
ID
createdAt:
updatedAt:
webhookEvent:
statusCode:
Int
requestBody:
responseBody:
responseTime:
Int
Example
{
  "id": "object",
  "createdAt": "object",
  "updatedAt": "object",
  "webhookEvent": {
    "id": "object",
    "eventId": "string",
    "createdAt": "object",
    "updatedAt": "object",
    "webhookEndpoint": {
      "id": "object",
      "createdAt": "object",
      "updatedAt": "object",
      "workspace": {
        "id": "object",
        "createdAt": "object",
        "name": "string",
        "description": "string",
        "organization": {
          "id": "object",
          "name": "string",
          "billingEmail": "string",
          "taxId": "string",
          "taxIdType": "string",
          "workspaces": [
            {
              "id": "object",
              "createdAt": "object",
              "name": "string",
              "description": "string",
              "organization": {
                "id": "object",
                "name": "string",
                "billingEmail": "string",
                "taxId": "string",
                "taxIdType": "string",
                "workspaces": [
                  {
                    "id": "object",
                    "createdAt": "object",
                    "name": "string",
                    "description": "string",
                    "organization": {
                      "id": "object",
                      "name": "string",
                      "billingEmail": "string",
                      "taxId": "string",
                      "taxIdType": "string",
                      "workspaces": [
                        {
                          "id": "object",
                          "createdAt": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

Workspace: object

id:
ID
createdAt:
name:
description:
organization:
views:
collaborators:
properties:
entries:
Example
{
  "id": "object",
  "createdAt": "object",
  "name": "string",
  "description": "string",
  "organization": {
    "id": "object",
    "name": "string",
    "billingEmail": "string",
    "taxId": "string",
    "taxIdType": "string",
    "workspaces": [
      {
        "id": "object",
        "createdAt": "object",
        "name": "string",
        "description": "string",
        "organization": {
          "id": "object",
          "name": "string",
          "billingEmail": "string",
          "taxId": "string",
          "taxIdType": "string",
          "workspaces": [
            {
              "id": "object",
              "createdAt": "object",
              "name": "string",
              "description": "string",
              "organization": {
                "id": "object",
                "name": "string",
                "billingEmail": "string",
                "taxId": "string",
                "taxIdType": "string",
                "workspaces": [
                  {
                    "id": "object",
                    "createdAt": "object",
                    "name": "string",
                    "description": "string",
                    "organization": {
                      "id": "object",
                      "name": "string",
                      "billingEmail": "string",
                      "taxId": "string",
                      "taxIdType": "string",
                      "workspaces": [
                        {
                          "id": "object",
                          "createdAt": "object",
                          "name": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

WorkspaceRole: object

organizationId:
workspaceId:
role:
Example
{
  "organizationId": "string",
  "workspaceId": "string",
  "role": "string"
}