Devices

Get all registered devices

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices

Returns all devices associated with the tenant, including their configuration and status.

Authorization

Requires Device.Read scope.

Pagination

Currently returns all devices. Pagination may be added in future versions if needed.

Use Cases

• Device inventory management
• Configuration deployment
• Status monitoring

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

List of all devices

text/plainapplication/jsontext/json

Device metadata exposed by the API.

deviceIdstringOptional

Unique device identifier.

namestringOptional

Device name.

descriptionstring · nullableOptional

Optional description.

isEnabledbooleanOptional

Whether the device is currently active.

typestring · enumOptional

Device type (CrewCheck, etc.).

Possible values:

settingsone ofOptional

Type-specific settings.

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while listing devices

get/api/{tenantId}/devices

HTTPcURLJavaScriptPython

GET /api/{tenantId}/devices HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "deviceId": "text",
    "name": "text",
    "description": null,
    "isEnabled": true,
    "type": "CrewCheck",
    "settings": {
      "logoUrl": "text",
      "nfc": {
        "apple": {
          "publicKey": "text",
          "passTypeIdentifier": "text"
        },
        "google": {
          "collectorId": "text"
        }
      }
    }
  }
]

Create a new device of the specified type.

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices

Creates a new device with the specified type and configuration. Currently supports CrewCheck device type with logo URL configuration.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Payload to create a new device.

typestring · enumOptional

Device type to create.

Possible values:

namestringOptional

Device name.

descriptionstring · nullableOptional

Optional device description.

Responses

201

Device created successfully

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while creating device

post/api/{tenantId}/devices

HTTPcURLJavaScriptPython

POST /api/{tenantId}/devices HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "type": "CrewCheck",
  "name": "text",
  "description": null
}

application/jsontext/jsonapplication/*+json

No content

Retrieve a device by id.

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices/{deviceId}

Returns detailed information about a specific device including its type and configuration settings.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

deviceIdstringRequired

Device identifier.

tenantIdstringRequired

Responses

200

Device details

No content

401

Not authorized

text/plainapplication/jsontext/json

404

Device not found

text/plainapplication/jsontext/json

500

Internal server error while retrieving device

get/api/{tenantId}/devices/{deviceId}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/devices/{deviceId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update a device.

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices/{deviceId}

Updates name, description, and enabled status.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

deviceIdstringRequired

Device identifier.

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Payload to update a device.

namestringOptional

Device name.

descriptionstring · nullableOptional

Optional description.

isEnabledbooleanOptional

Whether the device should be enabled.

Responses

200

Device updated successfully

No content

401

Not authorized

text/plainapplication/jsontext/json

404

Device not found

text/plainapplication/jsontext/json

500

Internal server error while updating device

put/api/{tenantId}/devices/{deviceId}

HTTPcURLJavaScriptPython

PUT /api/{tenantId}/devices/{deviceId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": null,
  "isEnabled": true
}

application/jsontext/jsonapplication/*+json

No content

Delete a device and revoke its API key.

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices/{deviceId}

Removes the device from the system and invalidates any associated API keys. This prevents the device from authenticating to the system.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

deviceIdstringRequired

Device identifier.

tenantIdstringRequired

Responses

202

Device deletion accepted

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while deleting device

delete/api/{tenantId}/devices/{deviceId}

HTTPcURLJavaScriptPython

DELETE /api/{tenantId}/devices/{deviceId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Connect a device using its API key and return device settings.

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices/{deviceId}/connect

Establishes a connection for the device and returns its current configuration settings. This endpoint verifies the device's authorization before allowing the connection.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

deviceIdstringRequired

Device identifier.

tenantIdstringRequired

Responses

200

Connection established with device settings

text/plainapplication/jsontext/json

Connect result information

settingsone ofOptional

Settings related to the connected device

400

Device is disabled

text/plainapplication/jsontext/json

401

Not authorized or invalid credentials

text/plainapplication/jsontext/json

404

Device not found

text/plainapplication/jsontext/json

500

Internal server error while connecting device

post/api/{tenantId}/devices/{deviceId}/connect

HTTPcURLJavaScriptPython

POST /api/{tenantId}/devices/{deviceId}/connect HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "settings": {
    "logoUrl": "text",
    "nfc": {
      "apple": {
        "publicKey": "text",
        "passTypeIdentifier": "text"
      },
      "google": {
        "collectorId": "text"
      }
    }
  }
}

Reset a device connection and return a fresh API key and environment details.

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/devices/{deviceId}/connections/reset

Generates a new API key for the device and returns connection details including the environment URI. This is useful when the device needs to reconnect or its credentials have been compromised.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Tenant identifier.

deviceIdstringRequired

Device identifier.

Responses

200

Connection token with new API key

text/plainapplication/jsontext/json

Connection token information returned to the device.

deviceIdstringOptional

Device identifier.

tenantIdstringOptional

Tenant identifier.

apiKeystringOptional

Issued API key for the device.

environmentstring · uriOptional

Environment base URI the device should call.

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while resetting device connection

post/api/{tenantId}/devices/{deviceId}/connections/reset

HTTPcURLJavaScriptPython

POST /api/{tenantId}/devices/{deviceId}/connections/reset HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "deviceId": "text",
  "tenantId": "text",
  "apiKey": "text",
  "environment": "https://example.com"
}