Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/TheSerchCp/SEAM-API/llms.txt

Use this file to discover all available pages before exploring further.

Returns every permission registered in the system, ordered ascending by idPermission. No role-permission check is applied — any authenticated user can call this endpoint. This is intentional so that administrators can browse available permissions when building role configurations.

Authentication

Requires a valid JWT in the Authorization header. No specific role permission is needed.

Request

Method: GET Path: /api/v1/permission

Headers

Authorization
string
required
Bearer token obtained from the login endpoint. Format: Bearer <token>

Response

200 OK

Returns all permission records in ascending idPermission order.
success
boolean
Always true for successful responses.
message
string
Human-readable status message. Value: "Permisos registados obtenidos".
data
array
Array of permission objects.
Example Response
{
  "success": true,
  "message": "Permisos registados obtenidos",
  "data": [
    {
      "idPermission": 1,
      "nameUri": "GET /api/v1/users",
      "description": "List all users"
    },
    {
      "idPermission": 2,
      "nameUri": "POST /api/v1/roles",
      "description": "Create a new role"
    },
    {
      "idPermission": 3,
      "nameUri": "DELETE /api/v1/users/:id",
      "description": "Delete a user by ID"
    }
  ]
}

Error Responses

StatusDescription
401 UnauthorizedMissing or invalid JWT token.
401 Unauthorized
{
  "success": false,
  "message": "No autorizado",
  "data": null
}

Code Example

cURL
curl -X GET http://localhost:3000/api/v1/permission \
  -H "Authorization: Bearer <your_token>"

Socket.IO Events

This is a read-only endpoint. A data:changed broadcast is not emitted. The requesting client receives operation:progress events for the permissions:fetchAll operation on their own socket only.
EventTargetOperationStatus sequence
operation:progressRequesting socketpermissions:fetchAllstartsuccess

Build docs developers (and LLMs) love