> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/zones.md).

# Sub-user geofences

Which of the master account's geofences a sub-user can see.

These operations set which [geofences](/docs/navixy-api/user-api/resources/tracking/zone.md) a [sub-user](/docs/navixy-api/user-api/resources/commons/subuser.md) can see. Geofences are scoped separately from trackers, so a sub-user's geofence list is bound here rather than following from [their trackers](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md).

Two list operations exist because they answer different questions: `list_ids` returns only the IDs, which is what a permissions screen needs, and `list` returns the geofence objects themselves.

## API actions

API base path: `/subuser/zones`.

Every operation on this page needs the `multilevel_access` tariff feature on **all** trackers, and the `admin` right, which is available only to master users. Failing either returns error 13 for the right and error 236 for the feature, so those two are not repeated per operation below.

Every operation here also returns error 201, Not found in the database, when the sub-user does not exist or belongs to another master user.

***

## Bind geofences to sub-user

> Give a sub-user access to geofences, either a named set or all of them.\
> \
> \*\*Give either \`access\_to\_all\` or \`zone\_ids\`.\*\* A request with neither reports a missing parameter named \`has\_at\_least\_one\_parameter\`, which is the internal name of the validation group rather than a parameter you can send; it carries a message naming the two real choices.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/zones/bind":{"post":{"tags":["Sub-users"],"summary":"Bind geofences to sub-user","description":"Give a sub-user access to geofences, either a named set or all of them.\n\n**Give either `access_to_all` or `zone_ids`.** A request with neither reports a missing parameter named `has_at_least_one_parameter`, which is the internal name of the validation group rather than a parameter you can send; it carries a message naming the two real choices.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserZonesBind","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"ID of a sub-user belonging to the current account.","minimum":1},"access_to_all":{"type":"boolean","description":"When `true`, the sub-user gets access to every geofence of the master account. Use this or `zone_ids`."},"zone_ids":{"type":"array","description":"IDs of the geofences to associate with the sub-user. All must belong to the current master account. Use this or `access_to_all`.","items":{"type":"integer"}}},"required":["subuser_id"]}}}},"responses":{"200":{"description":"Geofences bound","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 13 - The caller is a sub-user.
* 236 - The account lacks the `multilevel_access` feature.

***

## Unbind geofences from sub-user

> Take away a sub-user's access to geofences.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/zones/unbind":{"post":{"tags":["Sub-users"],"summary":"Unbind geofences from sub-user","description":"Take away a sub-user's access to geofences.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserZonesUnbind","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"ID of a sub-user belonging to the current account.","minimum":1},"zone_ids":{"type":"array","description":"IDs of the geofences to remove from the sub-user. All must belong to the current master account.","items":{"type":"integer"}}},"required":["subuser_id","zone_ids"]}}}},"responses":{"200":{"description":"Geofences unbound","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 13 - The caller is a sub-user.
* 236 - The account lacks the `multilevel_access` feature.

***

## List sub-user geofence IDs

> Return just the IDs of the geofences a sub-user can see.\
> \
> Use \`subuser/zones/list\` when you want the geofence objects themselves.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/zones/list_ids":{"post":{"tags":["Sub-users"],"summary":"List sub-user geofence IDs","description":"Return just the IDs of the geofences a sub-user can see.\n\nUse `subuser/zones/list` when you want the geofence objects themselves.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserZonesListIds","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"ID of a sub-user belonging to the current account.","minimum":1}},"required":["subuser_id"]}}}},"responses":{"200":{"description":"The geofence IDs in the sub-user's scope","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","description":"IDs of the geofences available to the sub-user.","items":{"type":"integer"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 13 - The caller is a sub-user.
* 236 - The account lacks the `multilevel_access` feature.

***

## List sub-user geofences

> Return the geofences a sub-user can see, as full geofence objects, with filtering and pagination.\
> \
> \*\*Master users only\*\*, and the account needs the \`multilevel\_access\` plan feature on \*\*all\*\* trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\
> \
> Requires the \`admin\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Sub-users","description":"Additional users under a master account: their security groups, and the trackers, places and geofences each one can see. All resources under the /subuser/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subuser/zones/list":{"post":{"tags":["Sub-users"],"summary":"List sub-user geofences","description":"Return the geofences a sub-user can see, as full geofence objects, with filtering and pagination.\n\n**Master users only**, and the account needs the `multilevel_access` plan feature on **all** trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.\n\nRequires the `admin` right.","operationId":"subuserZonesList","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"ID of a sub-user belonging to the current account.","minimum":1},"filter":{"type":"string","description":"Optional. Filter over geofence label."},"tag_ids":{"type":"array","description":"Optional. Tag IDs. A geofence must carry **all** the tags in the list to be returned.","items":{"type":"integer"}},"order":{"type":"string","description":"Optional. Default `id`. How to order the list.","enum":["id","label"]},"limit":{"type":"integer","description":"Optional. Maximum number of geofences to return."},"offset":{"type":"integer","description":"Optional. Default 0. Offset into the results, for pagination.","minimum":0}},"required":["subuser_id"]}}}},"responses":{"200":{"description":"The geofences in the sub-user's scope","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","description":"The geofences available to the sub-user. See the geofence documentation for the object shape.","items":{"type":"object","additionalProperties":true}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the account lacks the `multilevel_access` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the caller is a sub-user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 13 - The caller is a sub-user.
* 236 - The account lacks the `multilevel_access` feature.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/zones.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.