Me Actions

https://api.app.wnology.io/me

Below are the various requests that can be performed against the Me resource, as well as the expected parameters and the potential responses.

Add Recent Item

Adds an item to a recent item list

Method And Url

POST https://api.app.wnology.io/me/recentItems

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, me.*, me.addRecentItem, only.User, or only.User.bounded.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Recent Item schema. For example, the following would be a valid body for this request:

{
  "itemType": "device",
  "parentId": "575ec8687ae143cd83dc4a97",
  "itemId": "575ecf887ae143cd83dc4aa2"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"itemType":"device","parentId":"575ec8687ae143cd83dc4a97","itemId":"575ecf887ae143cd83dc4aa2"}' \
    https://api.app.wnology.io/me/recentItems

Successful Responses

Code	Type	Description
200	Recent Item List	Updated recent item list

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Change Password

Changes the current user's password and optionally logs out all other sessions

Method And Url

PATCH https://api.app.wnology.io/me/changePassword

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.changePassword, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Change Password schema. For example, the following would be a valid body for this request:

{
  "newPassword": "yourNewPassword1!",
  "password": "yourCurrentPassword",
  "invalidateExistingTokens": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"newPassword":"yourNewPassword1!","password":"yourCurrentPassword","invalidateExistingTokens":true}' \
    https://api.app.wnology.io/me/changePassword

Successful Responses

Code	Type	Description
200	Authenticated User	A new, valid, auth token (potentially all previous tokens are now invalid)

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Delete

Deletes the current user

Method And Url

POST https://api.app.wnology.io/me/delete

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.delete, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the User Credentials schema. For example, the following would be a valid body for this request:

{
  "email": "email@example.com",
  "password": "this is the password"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"email@example.com","password":"this is the password"}' \
    https://api.app.wnology.io/me/delete

Successful Responses

Code	Type	Description
200	Success	If the user was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Device Counts

Returns device counts by day for the time range specified for all applications the current user owns

Method And Url

GET https://api.app.wnology.io/me/deviceCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.deviceCounts, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for device count query (ms since epoch)		`start=0`
end	N	End of range for device count query (ms since epoch)		`end=1465790400000`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/deviceCounts

Successful Responses

Code	Type	Description
200	Device Counts	Device counts by day

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Disable Two Factor Auth

Disables multi-factor authentication for the current user

Method And Url

PATCH https://api.app.wnology.io/me/disableTwoFactorAuth

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.disableTwoFactorAuth, or only.User.

Request Query Parameters

Name	Required	Description	Example
includeRecent	N	Should the user include recent app/dashboard info	`includeRecent=true`
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary	`summaryExclude=payloadCount`
summaryInclude	N	Comma-separated list of summary fields to include in user summary	`summaryInclude=payloadCount`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Disable Multi-Factor Authentication schema. For example, the following would be a valid body for this request:

{
  "twoFactorCode": "123123",
  "password": "this would be your password"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"twoFactorCode":"123123","password":"this would be your password"}' \
    https://api.app.wnology.io/me/disableTwoFactorAuth

Successful Responses

Code	Type	Description
200	Me	Updated user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Disconnect Github

Disconnects the user from Github

Method And Url

PATCH https://api.app.wnology.io/me/disconnectGithub

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.disconnectGithub, or only.User.

Request Query Parameters

Name	Required	Description	Example
includeRecent	N	Should the user include recent app/dashboard info	`includeRecent=true`
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary	`summaryExclude=payloadCount`
summaryInclude	N	Comma-separated list of summary fields to include in user summary	`summaryInclude=payloadCount`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    https://api.app.wnology.io/me/disconnectGithub

Successful Responses

Code	Type	Description
200	Me	Updated user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Enable Two Factor Auth

Enables multi-factor authentication for the current user

Method And Url

PATCH https://api.app.wnology.io/me/enableTwoFactorAuth

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.enableTwoFactorAuth, or only.User.

Request Query Parameters

Name	Required	Description	Example
includeRecent	N	Should the user include recent app/dashboard info	`includeRecent=true`
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary	`summaryExclude=payloadCount`
summaryInclude	N	Comma-separated list of summary fields to include in user summary	`summaryInclude=payloadCount`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Enable Multi-Factor Authentication schema. For example, the following would be a valid body for this request:

{
  "twoFactorAuthKey": "HBBGWJJVOVLXS4ZGNRTDOUKTMESFUR3BMRWVQND2HJYT44TOMVJA",
  "password": "this would be your password",
  "twoFactorCode": "012345"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"twoFactorAuthKey":"HBBGWJJVOVLXS4ZGNRTDOUKTMESFUR3BMRWVQND2HJYT44TOMVJA","password":"this would be your password","twoFactorCode":"012345"}' \
    https://api.app.wnology.io/me/enableTwoFactorAuth

Successful Responses

Code	Type	Description
200	Me	Updated user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Fetch Recent Items

Gets a recent item list

Method And Url

GET https://api.app.wnology.io/me/recentItems

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.fetchRecentItems, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Default	Example
parentId	N	Parent id of the recent list		`parentId=575ec8687ae143cd83dc4a97`
itemType	Y	Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization		`itemType=application`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/recentItems?itemType=application

Successful Responses

Code	Type	Description
200	Recent Item List	Recent item list

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Generate Two Factor Auth

Returns the multi-factor authentication key for the current user

Method And Url

PATCH https://api.app.wnology.io/me/generateTwoFactorAuth

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.generateTwoFactorAuth, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    https://api.app.wnology.io/me/generateTwoFactorAuth

Successful Responses

Code	Type	Description
200	Multi-Factor Authentication Info	Multi-factor authentication info

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Get

Retrieves information on the current user

Method And Url

GET https://api.app.wnology.io/me

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.get, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Example
includeRecent	N	Should the user include recent app/dashboard info	`includeRecent=true`
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary	`summaryExclude=payloadCount`
summaryInclude	N	Comma-separated list of summary fields to include in user summary	`summaryInclude=payloadCount`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me

Successful Responses

Code	Type	Description
200	Me	Current user information

Error Responses

Code	Type	Description

Invite

Retrieves information for an invitation to an organization

Method And Url

GET https://api.app.wnology.io/me/invites/INVITE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.invite, only.User, only.User.bounded, or only.User.read.

Request Path Components

Path Component	Description	Example
INVITE_ID	ID associated with the invitation	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/invites/INVITE_ID

Successful Responses

Code	Type	Description
200	Organization Invitation Information For User	Information about invitation

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if invite not found

Invites

Retrieves pending organization invitations for a user

Method And Url

GET https://api.app.wnology.io/me/invites

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.invites, only.User, only.User.bounded, or only.User.read.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/invites

Successful Responses

Code	Type	Description
200	User Organization Invitations	Information about invitations

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for all applications the current user owns

Method And Url

GET https://api.app.wnology.io/me/notebookMinuteCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.notebookMinuteCounts, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for notebook execution query (ms since epoch)		`start=0`
end	N	End of range for notebook execution query (ms since epoch)		`end=1465790400000`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/notebookMinuteCounts

Successful Responses

Code	Type	Description
200	Notebook Minute Counts	Notebook usage information

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Patch

Updates information about the current user

Method And Url

PATCH https://api.app.wnology.io/me

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.patch, or only.User.

Request Query Parameters

Name	Required	Description	Example
includeRecent	N	Should the user include recent app/dashboard info	`includeRecent=true`
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary	`summaryExclude=payloadCount`
summaryInclude	N	Comma-separated list of summary fields to include in user summary	`summaryInclude=payloadCount`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Me Patch schema. For example, the following would be a valid body for this request:

{
  "email": "email@example.com",
  "firstName": "Example",
  "lastName": "Name",
  "companyName": "Example, Inc.",
  "url": "https://example.com",
  "password": "My new password!!1"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"email":"email@example.com","firstName":"Example","lastName":"Name","companyName":"Example, Inc.","url":"https://example.com","password":"My new password!!1"}' \
    https://api.app.wnology.io/me

Successful Responses

Code	Type	Description
200	Me	Updated user information

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Payload Counts

Returns payload counts for the time range specified for all applications the current user owns

Method And Url

GET https://api.app.wnology.io/me/payloadCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.payloadCounts, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		`start=0`
end	N	End of range for payload count query (ms since epoch)		`end=1465790400000`
asBytes	N	If the resulting stats should be returned as bytes	false	`asBytes=true`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/payloadCounts

Successful Responses

Code	Type	Description
200	Payload Stats	Payload counts, by type and source

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for all applications the current user owns

Method And Url

GET https://api.app.wnology.io/me/payloadCountsBreakdown

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, me.*, me.payloadCountsBreakdown, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		`start=0`
end	N	End of range for payload count query (ms since epoch)		`end=1465790400000`
resolution	N	Resolution in milliseconds. Accepted values are: 86400000, 3600000	86400000	`resolution=86400000`
asBytes	N	If the resulting stats should be returned as bytes	false	`asBytes=true`
includeNonBillable	N	If non-billable payloads should be included in the result	false	`includeNonBillable=true`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/payloadCountsBreakdown

Successful Responses

Code	Type	Description
200	Payload Counts Breakdown	Sum of payload counts by date

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Refresh Token

Returns a new auth token based on the current auth token

Method And Url

GET https://api.app.wnology.io/me/refreshToken

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.refreshToken, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/me/refreshToken

Successful Responses

Code	Type	Description
200	Authenticated User	Successful token regeneration

Error Responses

Code	Type	Description
400	Error	Error if malformed request
401	Error	Unauthorized error if authentication fails

Respond to Invite

Accepts or rejects an invitation to an organization

Method And Url

POST https://api.app.wnology.io/me/invites/INVITE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.respondToInvite, or only.User.

Request Path Components

Path Component	Description	Example
INVITE_ID	ID associated with the invitation	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Organization Invitation Action For User schema. For example, the following would be a valid body for this request:

{
  "action": "accept"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"action":"accept"}' \
    https://api.app.wnology.io/me/invites/INVITE_ID

Successful Responses

Code	Type	Description
200	Organization Invitation Result For User	Acceptance or rejection of invitation

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if invitation not found
410	Error	Error if invitation has expired

Transfer Resources

Moves resources to a new owner

Method And Url

PATCH https://api.app.wnology.io/me/transferResources

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.transferResources, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Resource Transfer schema. For example, the following would be a valid body for this request:

{
  "destinationId": "575ed6e87ae143cd83dc4aa8",
  "destinationType": "organization",
  "applicationIds": [
    "575ec8687ae143cd83dc4a97"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"destinationId":"575ed6e87ae143cd83dc4aa8","destinationType":"organization","applicationIds":["575ec8687ae143cd83dc4a97"]}' \
    https://api.app.wnology.io/me/transferResources

Successful Responses

Code	Type	Description
200	Success	If resource transfer was successful

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Verify Email

Sends an email verification to the user

Method And Url

POST https://api.app.wnology.io/me/verify-email

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, me.*, me.verifyEmail, or only.User.

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.app.wnology.io/me/verify-email

Successful Responses

Code	Type	Description
200	Success	If email verification was successfully sent

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Authenticated User

Schema for the successful response when authenticating a User

Authenticated User Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys▶
userId:{} 2 keys
▶
token:{} 2 keys
▶
needsToVerifyEmail:{} 1 key
▶
orgId:{} 2 keys
▶
required:[] 2 items

Authenticated User Example

▶
(root){} 2 keysuserId:"575ed70c7ae143cd83dc4aa9"
token:"token_to_use_for_authenticating_subsequent_requests"

Change Password

Schema for the body of a request to change the current user's password

Change Password Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
twoFactorCode:{} 2 keys
▶
password:{} 3 keys
▶
newPassword:{} 4 keys
▶
invalidateExistingTokens:{} 1 key
▶
tokenTTL:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

Change Password Example

▶
(root){} 3 keysnewPassword:"yourNewPassword1!"
password:"yourCurrentPassword"
invalidateExistingTokens:true

Device Counts

Schema for the result of a device counts request

Device Counts Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Device Counts Example

▶
(root){} 3 keysstart:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keystype:"NotFound"
message:"Application was not found"

Me

Schema for information about the currently authenticated user

Me Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 29 keys▶
id:{} 2 keys
▶
userId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
passwordLastUpdated:{} 2 keys
▶
email:{} 3 keys
▶
requestedEmail:{} 3 keys
▶
firstName:{} 3 keys
▶
lastName:{} 2 keys
▶
companyName:{} 2 keys
▶
title:{} 2 keys
▶
phoneNumber:{} 2 keys
▶
location:{} 2 keys
▶
url:{} 2 keys
▶
tokenCutoff:{} 2 keys
▶
emailVerified:{} 1 key
▶
needsToVerifyEmail:{} 1 key
▶
twoFactorAuthEnabled:{} 1 key
▶
fullName:{} 1 key
▶
githubName:{} 1 key
▶
avatarUrl:{} 3 keys
▶
limits:{} 3 keys
▶
recentDashboards:{} 4 keys
▶
recentApplications:{} 4 keys
▶
recentOrganizations:{} 4 keys
▶
summary:{} 2 keys
▶
currentPeriodStart:{} 2 keys
▶
currentPeriodEnd:{} 2 keys
▶
ssoLinked:{} 1 key

Me Example

▶
(root){} 16 keysid:"575ed70c7ae143cd83dc4aa9"
userId:"575ed70c7ae143cd83dc4aa9"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
passwordLastUpdated:"2016-06-13T04:00:00.000Z"
email:"email@example.com"
firstName:"Example"
lastName:"Name"
companyName:"Example, Inc."
url:"https://example.com"
emailVerified:true
needsToVerifyEmail:false
twoFactorAuthEnabled:false
fullName:"Example Name"
▶
summary:{} 8 keys
ssoLinked:false

Me Patch

Schema for the body of request to modify the current user

Me Patch Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys▶
email:{} 3 keys
▶
firstName:{} 3 keys
▶
lastName:{} 2 keys
▶
companyName:{} 2 keys
▶
title:{} 2 keys
▶
phoneNumber:{} 2 keys
▶
location:{} 2 keys
▶
url:{} 2 keys
▶
password:{} 4 keys
▶
tokenCutoff:{} 2 keys
▶
currentCredentials:{} 4 keys
additionalProperties:false

Me Patch Example

▶
(root){} 6 keysemail:"email@example.com"
firstName:"Example"
lastName:"Name"
companyName:"Example, Inc."
url:"https://example.com"
password:"My new password!!1"

Disable Multi-Factor Authentication

Schema for the body of a request to disable multi-factor authentication

Disable Multi-Factor Authentication Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
twoFactorCode:{} 2 keys
▶
password:{} 3 keys
▶
required:[] 2 items
additionalProperties:false

Disable Multi-Factor Authentication Example

▶
(root){} 2 keystwoFactorCode:"123123"
password:"this would be your password"

Enable Multi-Factor Authentication

Schema for the body of a request to enable multi-factor authentication

Enable Multi-Factor Authentication Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
twoFactorAuthKey:{} 3 keys
▶
password:{} 3 keys
▶
twoFactorCode:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

Enable Multi-Factor Authentication Example

▶
(root){} 3 keystwoFactorAuthKey:"HBBGWJJVOVLXS4ZGNRTDOUKTMESFUR3BMRWVQND2HJYT44TOMVJA"
password:"this would be your password"
twoFactorCode:"012345"

Multi-Factor Authentication Info

Schema for information about multi-factor authentication

Multi-Factor Authentication Info Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
key:{} 2 keys
▶
keyUri:{} 2 keys
additionalProperties:false

Multi-Factor Authentication Info Example

▶
(root){} 2 keyskey:"HBBGWJJVOVLXS4ZGNRTDOUKTMESFUR3BMRWVQND2HJYT44TOMVJA"
keyUri:"string"

Notebook Minute Counts

Schema for the result of a notebook minute counts request

Notebook Minute Counts Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Notebook Minute Counts Example

▶
(root){} 3 keysstart:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Organization Invitation Action For User

Schema for the body of a request to accept or reject an invitation

Organization Invitation Action For User Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key▶
action:{} 2 keys
additionalProperties:false
▶
required:[] 1 item

Organization Invitation Action For User Example

▶
(root){} 1 keyaction:"accept"

Organization Invitation Result For User

Schema for the result of accepting/rejecting an invitation

Organization Invitation Result For User Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
result:{} 2 keys
▶
orgId:{} 2 keys

Organization Invitation Result For User Example

▶
(root){} 2 keysresult:"rejected"
orgId:"575ed6e87ae143cd83dc4aa8"

Organization Invitation Information For User

Schema for information about an invitation

Organization Invitation Information For User Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys▶
orgName:{} 3 keys
▶
role:{} 2 keys
▶
requiresMFA:{} 1 key
▶
inviteDate:{} 2 keys
▶
ttl:{} 1 key
▶
expired:{} 1 key
▶
id:{} 2 keys
▶
invitedBy:{} 2 keys

Organization Invitation Information For User Example

▶
(root){} 6 keysorgName:"My org"
role:"edit"
requiresMFA:false
inviteDate:"2023-09-06T16:41:15.049Z"
ttl:4233600000
expired:true

User Organization Invitations

Schema for an array of pending organization invitations for a user

User Organization Invitations Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 2 keys

User Organization Invitations Example

▶
(root)[] 2 items▶
0:{} 6 keys
▶
1:{} 6 keys

Payload Counts Breakdown

Schema for the result of a payload counts breakdown request

Payload Counts Breakdown Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Payload Counts Breakdown Example

▶
(root){} 3 keysstart:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Stats

Schema for the result of a payload stats request

Payload Stats Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys▶
appFile:{} 2 keys
▶
dataTable:{} 2 keys
▶
deviceCreate:{} 2 keys
▶
deviceCommand:{} 2 keys
▶
deviceConnect:{} 2 keys
▶
deviceDisconnect:{} 2 keys
▶
deviceState:{} 2 keys
▶
endpoint:{} 2 keys
▶
event:{} 2 keys
▶
flowError:{} 2 keys
▶
inboundEmail:{} 2 keys
▶
integration:{} 2 keys
▶
mqttIn:{} 2 keys
▶
mqttOut:{} 2 keys
▶
notebook:{} 2 keys
▶
resourceJob:{} 2 keys
▶
timer:{} 2 keys
▶
virtualButton:{} 2 keys
▶
webhook:{} 2 keys

Payload Stats Example

▶
(root){} 6 keys▶
timer:{} 1 key
▶
deviceState:{} 2 keys
▶
mqttOut:{} 1 key
▶
webhook:{} 1 key
▶
deviceConnect:{} 1 key
▶
deviceDisconnect:{} 1 key

Recent Item

Schema for the body of a request to add a recent item

Recent Item Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
itemType:{} 2 keys
▶
parentId:{} 2 keys
▶
itemId:{} 2 keys
▶
required:[] 2 items

Recent Item Example

▶
(root){} 3 keysitemType:"device"
parentId:"575ec8687ae143cd83dc4a97"
itemId:"575ecf887ae143cd83dc4aa2"

Recent Item List

Schema for an array of recent items

Recent Item List Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
itemType:{} 2 keys
▶
parentId:{} 2 keys
▶
items:{} 2 keys

Recent Item List Example

▶
(root){} 2 keysitemType:"application"
▶
items:[] 2 items

Resource Transfer

Schema for the body of a resource transfer request

Resource Transfer Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
destinationId:{} 2 keys
▶
destinationType:{} 2 keys
▶
applicationIds:{} 3 keys
▶
dashboardIds:{} 3 keys
▶
strict:{} 1 key
additionalProperties:false
▶
required:[] 2 items

Resource Transfer Example

▶
(root){} 3 keysdestinationId:"575ed6e87ae143cd83dc4aa8"
destinationType:"organization"
▶
applicationIds:[] 1 item

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key▶
success:{} 2 keys

Success Example

▶
(root){} 1 keysuccess:true

User Credentials

Schema for the body of a User authentication request

User Credentials Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
email:{} 3 keys
▶
password:{} 3 keys
▶
twoFactorCode:{} 2 keys
▶
requestedScopes:{} 3 keys
▶
tokenTTL:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

User Credentials Example

▶
(root){} 2 keysemail:"email@example.com"
password:"this is the password"

Was this page helpful?

Still looking for help? You can also search the WEGnology Forums or submit your question there.

Add Recent Item​

Method And Url ​

Authentication ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Change Password​

Method And Url ​

Authentication ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Delete​

Method And Url ​

Authentication ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Device Counts​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Disable Two Factor Auth​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Disconnect Github​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Enable Two Factor Auth​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Fetch Recent Items​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Generate Two Factor Auth​

Method And Url ​

Authentication ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Get​

Method And Url ​

Authentication ​

Request Query Parameters ​

Request Headers ​

Curl Example ​

Successful Responses ​

Add Recent Item

Method And Url

Authentication

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Change Password

Method And Url

Authentication

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Delete

Method And Url

Authentication

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Device Counts

Method And Url

Authentication

Request Query Parameters

Request Headers

Curl Example

Successful Responses

Error Responses

Disable Two Factor Auth

Method And Url

Authentication

Request Query Parameters

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Disconnect Github

Method And Url

Authentication

Request Query Parameters

Request Headers

Curl Example

Successful Responses

Error Responses

Enable Two Factor Auth

Method And Url

Authentication

Request Query Parameters

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Fetch Recent Items

Method And Url

Authentication

Request Query Parameters

Request Headers

Curl Example

Successful Responses

Error Responses

Generate Two Factor Auth

Method And Url

Authentication

Request Headers

Curl Example

Successful Responses

Error Responses

Get

Method And Url

Authentication

Request Query Parameters

Request Headers

Curl Example

Successful Responses