> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/permission.md).

# Permission

The permission endpoint answers what the calling user is allowed to do, so a client can decide what to offer before trying it.

## Check what the caller may do

> Asks whether the caller may perform given actions, several at once. Each request names a \`domain\`, a\
> \`resource\` and an \`action\`; the answer repeats them with \`allowed\` next to each, in the same order.\
> \
> This does not perform anything — it only reports the decision the API would make.<br>

```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"The permission endpoint answers what the calling user is allowed to do, so a client can decide what to\noffer before trying it.\n","name":"permission"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer <token>`.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.CheckPermissionsRequest":{"properties":{"requests":{"items":{"$ref":"#/components/schemas/v1.CheckPermissionsRequestItem"},"minItems":1,"type":"array","uniqueItems":false}},"required":["requests"],"type":"object"},"v1.CheckPermissionsRequestItem":{"properties":{"action":{"$ref":"#/components/schemas/domain.Action"},"domain":{"type":"string"},"resource":{"type":"string"}},"required":["action","domain","resource"],"type":"object"},"domain.Action":{"enum":["","create","read","write","manage","assign","close","delete"],"type":"string"},"v1.CheckPermissionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/v1.CheckPermissionsResponseItem"},"type":"array","uniqueItems":false}},"type":"object"},"v1.CheckPermissionsResponseItem":{"properties":{"action":{"$ref":"#/components/schemas/domain.Action"},"allowed":{"type":"boolean"},"domain":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/permissions/check":{"post":{"description":"Asks whether the caller may perform given actions, several at once. Each request names a `domain`, a\n`resource` and an `action`; the answer repeats them with `allowed` next to each, in the same order.\n\nThis does not perform anything — it only reports the decision the API would make.\n","operationId":"checkPermissions","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.CheckPermissionsRequest","summary":"request","description":"Decisions to ask for"}]}}},"description":"Decisions to ask for","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.CheckPermissionsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Check what the caller may do","tags":["permission"]}}}}
```


---

# 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://hub.equipme.io/development/api-reference-app/permission.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.