List app users

GET /apps/{appId}/users

Bearer auth

Get all users for a specific app

Path parameters

appId integer Required

App ID

Responses

200 application/json

List of users
Hide response attributes Show response attributes object
- createdAt string
  
  Creation timestamp
- edges object
  
  Hide edges attribute Show edges attribute object
  
  roles array[object]
  
  User's role and permissions within a workspace
  
  Hide roles attributes Show roles attributes object
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attribute Show edges attribute object
  
  workspace object Required
  
  Workspace represents a user's context for API operations. Use the workspace ID in the Workspace-ID header
  
  Hide workspace attributes Show workspace attributes object
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Workspace ID - use this value in the Workspace-ID header for API requests
  
  name string Required
  
  Workspace name
  
  type string
  
  Workspace type (personal/business)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Workspace role ID
  
  role string Required
  
  Workspace role (e.g., admin, member)
  
  updatedAt string
  
  Last update timestamp
- email string Required
  
  User email
- id integer Required
  
  User ID
- status string
  
  User status (e.g., pending, completed)
- userType string
  
  User type (personal/business)
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message

GET /apps/{appId}/users

curl \
 --request GET 'https://bank.bank.place/apps/{appId}/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "createdAt": "string",
    "edges": {
      "roles": [
        {
          "createdAt": "string",
          "edges": {
            "workspace": {
              "createdAt": "string",
              "id": 42,
              "name": "string",
              "type": "string",
              "updatedAt": "string"
            }
          },
          "id": 42,
          "role": "string",
          "updatedAt": "string"
        }
      ]
    },
    "email": "string",
    "id": 42,
    "status": "string",
    "userType": "string"
  }
]

Response examples (401)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}