# Brain Web API API

> Brain Web API API on Apizie: 77 endpoints (Authentication information, Get all binary large objects (blob), Create binary large object (blob) metadata, Get binary large object (blob), …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/iot:intellifi-nl/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `iot:intellifi-nl`
- Category: IoT
- Status: byok
- Source: https://intellifi.zendesk.com
- Page: https://zieapi.vercel.app/api/iot/intellifi-nl
- OpenAPI: https://zieapi.vercel.app/api/iot/intellifi-nl/openapi.json

This document describes the [Intellifi Brain](https://intellifi.zendesk.com/hc/en-us/categories/360000685454) Web API specification using the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification). The…

## Endpoints

### Authentication information
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-authinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |

### Get all binary large objects (blob)
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-blobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| hash | string | no | Filter based on the hash of the blob. |
| blob_key | string | no | Filter based on the unique blob_key |
| content_type | string | no | Filter based on the content type of the blob. |
| filename | string | no | Filter based on the filename of the blob. |
| time_last_accessed | string | no | Filter based on the last time the blob was accessed |

### Create binary large object (blob) metadata
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-blob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get binary large object (blob)
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-blob-metadata-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Delete binary large object (blob)
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-blob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Download a binary large object (blob)
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-blob-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| filename | string | yes | Filename of the blob. |

### Create binary large object (blob)
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/upload-blob-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | no | Form fields as a JSON object |

### Get all events
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| topic.resource_type | string | no | Filter on the topic resource type |
| topic.action | string | no | Filter on the topic action |
| topic.resource | string | no | Filter on the topic resource id |
| time_event | string | no | Filter on the time the event was generated on the device. |
| time_expire | string | no | Filter on the time the event will expire. |

### Get event
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all items
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| after_code | string | no | Limits directly on `code_hex`. Marks the start of a range, optionally use `before_code` to set the end. Result output excludes the given… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| before_code | string | no | Limits directly on `code_hex`. Marks the end of a range, optionally use `after_code` to set the start. Result output excludes the given… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| from_code | string | no | Limits on `code_hex`. Marks the start of a range, optionally use `until_code` to set the end. Result output includes the given `code_hex`… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| until_code | string | no | Limits on `code_hex`. Marks the end of a range, optionally use `from_code` to set the start. Result output includes the given `code_hex`… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| code_hex | string | no | Filter based on the hexadecimal string representation of the item. Supports wildcards: `*`. |
| is_present | boolean | no | Only show items which are present of not. |
| label | string | no | Filter based on the label value. Supports wildcards: `*` |
| location | string | no | Filter based on the location |
| metadata | string | no | Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on… |
| move_count | integer | no | Filter based on move count |
| protocol | string | no | Filter based on the detected protocol of an item. |
| sets | string | no | Filter based on the set the resource is in. |
| technology | string | no | Filter based on the detected technology of an item. |
| text | string | no | Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote… |
| time_last_present | string | no | Filter based on the time last present |
| time_moved | string | no | Filter based on time last moved |
| type | string | no | Filter based on the type of an item. |

### Create item
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get item
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-item-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing item
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete item
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all keys
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| secret | string | no | Filter on the secret token. |
| label | string | no | Filter on the label. |
| is_read_only | boolean | no | Filter on read only status. |

### Create key
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get key
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-key-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing key
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete key
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all key-value pairs
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-kv-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| kv_key | string | no | Filter on the key-value pair key value. |

### Create key-value pair
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-kv-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get key-value pair
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-kv-pairs-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing Key-value pair
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-kv-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete key-value pair
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-kv-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all location rules
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-location-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| label | string | no | Filter based on the label value. Supports wildcards: `*` |
| type | string | no | Filter based on the type of location rule. |
| enabled | boolean | no | Filter based on the `enabled` property. |

### Create location rule
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-location-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get location rule
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-location-rule-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing location rule
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-location-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete location rule
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-location-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all locations
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-locations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| label | string | no | Filter based on the label value. Supports wildcards: `*` |
| metadata | string | no | Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on… |
| text | string | no | Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote… |

### Create location
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get location
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-location-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing location
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete location
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all presences
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-presences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| item | string | no | Filter based on the item |
| location | string | no | Filter based on the location |
| proximity | string | no | Filter based on the proximity. |
| technology | string | no | Filter based on the detected technology of an item. |

### Get presence
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-presence-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get all services
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| name | string | no | Filter based on the name of the resource. Supports wildcards: `*` |

### Get service
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-service-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing service
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Get all item lists
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-item-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| label | string | no | Filter based on the label value. Supports wildcards: `*` |
| metadata | string | no | Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on… |
| text | string | no | Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote… |
| total | integer | no | Filter based on the total amount of items in the list |
| sha1 | string | no | The sha1 checksum of the list. This will change when the list is mutated. |

### Create item list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-item-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get item list
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-item-list-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing item list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-item-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete item list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-item-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get item ids for this list
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-item-list-ids-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Add items to an existing list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-item-ids-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete item from list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-item-id-from-item-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| itemId | string | yes | Item ID. |

### Get all spot lists
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| label | string | no | Filter based on the label value. Supports wildcards: `*` |
| metadata | string | no | Filter based on metadata. Does a partial match on any value in the metadata object. It is also possible to do an exact/wildcard match on… |
| text | string | no | Filter based on a full text search. Searched properties depend on the resource type. Matches on any of the given words. Supports quote… |
| total | integer | no | Filter based on the total amount of spots in the list |

### Create spot list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-spot-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Info for a specific spot list
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-list-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing spot list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-spot-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete spot list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-spot-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get spot ids for this list
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-list-ids-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Add spots to an existing list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-item-ids-spot-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete spot from list
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-item-id-from-spot-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| itemId | string | yes | Item ID. |

### Get all spots
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| is_online | boolean | no | Filter based on the online status. |
| request_counter | integer | no | Filter based on the amount of request made |
| serial_number | integer | no | Filter based on the serial number. |

### Get spot
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing spot
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-spot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Get spotsets
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-sets-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Create spotset
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-spot-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Get spotset
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spot-set-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| setId | string | yes | Unique spot set identifier |

### Update existing spotset
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-spot-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| setId | string | yes | Unique spot set identifier |
| body | object | yes | JSON request body |

### Get spotsets
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spotsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |

### Create spotset
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/post-spotsets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get spotset
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-spotsets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing spotset
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/put-spotsets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Get all subscriptions
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| topic_filter | string | no | Filter on the topic filter. Make sure to use [percent-encoding](https://en.wikipedia.org/wiki/Percent-encoding) in the query parameter. |
| description | string | no | Filter based on the description. |
| database_hold_time_h | integer | no | Filter based on the number of hours events are retained in the database. |
| populate_events | boolean | no | Filter based on subscriptions that populate the events |
| verify_target_certificate | boolean | no | Filter on the verification of the target certificate. |

### Create subscription
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get subscription
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-subscription-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing subscription
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete subscription
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Get subscription events
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-events-for-subscription-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| topic.resource_type | string | no | Filter on the topic resource type |
| topic.action | string | no | Filter on the topic action |
| topic.resource | string | no | Filter on the topic resource id |
| time_event | string | no | Filter on the time the event was generated on the device. |
| time_expire | string | no | Filter on the time the event will expire. |

### Get all users
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| after | string | no | Limits on `time_created`, Marks the start of a range, optionally use `before` to set the end. Result output excludes the given timestamp. |
| after_id | string | no | Limits directly on `id`. Marks the start of a range, optionally use `before_id` to set the end. Result output excludes the given `id`… |
| before | string | no | Limits on `time_created`. Marks the end of a range, optionally use `after` to set the start. Result output excludes the given timestamp. |
| before_id | string | no | Limits directly on `id`. Marks the end of a range, optionally use `after_id` to set the start. Result output excludes the given `id`… |
| from | string | no | Limits on `time_created`. Marks the start of a range, optionally use `until` to set the end. Result output includes the given timestamp. |
| from_id | string | no | Limits on `id`. Marks the start of a range, optionally use `until_id` to set the end. Result output includes the given `id` value. Please… |
| id_only | boolean | no | Removes `url` fields from output and shows `_id` instead of `_url` in references. |
| limit | integer | no | Sets the maximum number of returned resources. You may increase this number to large values, keep in mind that query times could become… |
| populate | string | no | Expand a reference into the actual resource (lookup). You may add multiple fields by giving a comma separated value. |
| results_only | boolean | no | Removes response envelope with information about query, only sends back a JSON array with the applicable resources. |
| select | string | no | Select which properties should be returned. You may add multiple fields by giving a comma separated value. Select can also be used… |
| sort | string | no | Allows you to sort on on or more fields in the resource. You may append a minus sign (`-`) to request reverse order (new to old). |
| until | string | no | Limits on `time_created`. Marks the end of a range, optionally use `from` to set the start. Result output includes the given timestamp. |
| until_id | string | no | Limits on `id`. Marks the end of a range, optionally use `from_id` to set the start. Result output includes the given `id` value. Please… |
| timeout_s | number | no | Overrides the default query timeout (in seconds). A value of 0 means unlimited. IMPORTANT: using high timeouts in production code is… |
| id | string | no | Unique identifier |
| time_created | string | no | Filter on the time the resource was created. |
| time_updated | string | no | Filter on the time the resource was last updated |
| email | string | no | Filter on the email address. |
| first_name | string | no | Filter on the first name. |
| last_name | string | no | Filter on the last name. |
| is_admin | boolean | no | Filter on the administrator status. |
| is_locked | boolean | no | Filter on the locked status. |

### Create user
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/add-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| body | object | yes | JSON request body |

### Get user
`GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

### Update existing user
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |
| body | object | yes | JSON request body |

### Delete user
`POST https://zieapi.vercel.app/v1/iot:intellifi-nl/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| protocol | string | no | Your Brain Web API endpoint URL, for example https://myresource.example.com |
| tld | string | no | Part of the server address: {protocol}://brain.intellifi.{tld}/api |
| id | string | yes | Unique identifier |

## Example
```
curl "https://zieapi.vercel.app/v1/iot:intellifi-nl/get-authinfo" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Brain Web API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/iot:intellifi-nl/get-authinfo with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Brain Web API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Brain Web API itself also needs your own key from intellifi.nl.

### Can AI agents use the Brain Web API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key iot:intellifi-nl.

### What is the status of the Brain Web API API?
Needs your own provider key (bring your own key)
