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

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

List Network Owners

Request

Retrieve paginated array of all users that are network owners

Security
Authorization
Path
page_numberstringrequired

current page number

count_numberstringrequired

Number of items per page

Default 25
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/users/{page_number}/{count_number}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
user_idinteger
emailstring
first_namestring
last_namestring
external_idinteger
network_idinteger
]
Response
application/json
[
  {
    "user_id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "external_id": 0,
    "network_id": 0
  }
]

Password Reset

Request

Security
Authorization
Bodyapplication/json
emailstring(email)required
passwordstring>= 6 charactersrequired
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/users/reset \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "password": "string"
  }'

Responses

Bodyapplication/json
idinteger
Example: 3
usernamestring
Example: "jsmith"
emailstring
Example: "john.smith@cognitivesystems.com"
first_namestring
Example: "John"
last_namestring
Example: "Smith"
created_atstring
Example: "2020-08-27T20:44:38.793Z"
updated_atstring
Example: "2020-11-10T20:08:40.754Z"
confirmed_atstring or null
Example: "2020-08-27T20:44:38.793Z"
Response
application/json
{
  "id": 3,
  "username": "jsmith",
  "email": "john.smith@cognitivesystems.com",
  "first_name": "John",
  "last_name": "Smith",
  "created_at": "2020-08-27T20:44:38.793Z",
  "updated_at": "2020-11-10T20:08:40.754Z",
  "confirmed_at": "2020-08-27T20:44:38.793Z"
}

Global Search

Request

Path
search_keystringrequired

Email, first-name, or last-name

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/search/{search_key}'

Responses

Bodyapplication/jsonArray [
first_namestring
last_namestring
emailstring
network_idinteger
network_namestring
user_countinteger
external_idinteger
token_timestampsArray of objects
online_statusboolean
]
Response
application/json
[
  {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@gmail.com",
    "network_id": 185,
    "network_name": "3e362f",
    "user_count": 2,
    "external_id": 156,
    "token_timestamps": [],
    "online_status": true
  }
]