Skip to content

Cognitive Systems App Cloud API

The AppCloud APIs are used by mobile applications to communicate with the Cognitive Systems Infrastructure.

Download OpenAPI description
app_cloud.json
app_cloud.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/

https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Delete Confirmed User

Request

Security
Authorization
Path
idinteger>= 1required
Query
delete_claimed_networkboolean

Defaults to false. Delete the network associated with the user. If the user is a network owner, the network is completely deleted.

curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/users/{id}?delete_claimed_network=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Response
No content

Create Pending Invitation

Request

Sends an invite email to the provided list, the link in the email should take the invited users to the app, where they can create an account.

NOTE: Only the network owner may send Network Member Invites.

Bodyapplication/json
network_idstringrequired
emailsArray of stringsrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/member_invites \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": "string",
    "emails": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
failed_emailsArray of strings
Response
application/json
{
  "failed_emails": [
    "string"
  ]
}

Set New Account Password

Request

Sends email to given address with password reset link that redirects to static reset page

Security
Authorization
Bodyapplication/json
emailstring
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/password_resets \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string"
  }'

Responses

Bodyapplication/json
idinteger
emailstring
first_namestring
last_namestring
usernamestring
confirmed_atstring or null
created_atstring
updated_atstring
Response
application/json
{
  "id": 0,
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "username": "string",
  "confirmed_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Network Settings

Operations

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations