---
updatedAt: 2026-07-02T14:54:49.000Z
---

# Retrieves list of Api Accounts

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BeyondTrust PM Cloud Management API - Version 2",
    "description": "BeyondTrust PM Cloud Management API - Version 2",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://{example.com}/management-api"
    }
  ],
  "paths": {
    "/v2/ApiAccounts": {
      "get": {
        "tags": [
          "ApiAccounts"
        ],
        "summary": "Retrieves list of Api Accounts",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApiAccountListItemModel"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApiAccountListItemModel"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApiAccountListItemModel"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearer": [],
            "oauth2": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiAccountListItemModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Id (Guid format), for example - 59A00329-87AC-49EC-BC2C-9B9E26F05185",
            "format": "uuid"
          },
          "locked": {
            "type": "boolean"
          },
          "errorInfo": {
            "$ref": "#/components/schemas/ListItemErrorInfoModel"
          },
          "name": {
            "type": "string",
            "description": "Name of Api Account",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Description of Api Account",
            "nullable": true
          },
          "clientId": {
            "type": "string",
            "description": "Client Id",
            "nullable": true
          },
          "createdDate": {
            "type": "string",
            "description": "Date api account was created",
            "format": "date-time",
            "nullable": true
          },
          "scimAccess": {
            "type": "integer",
            "description": "Scim Access Permissions\r\nNoAccess = 0\r\nFullAccess = 2",
            "format": "int32"
          },
          "urmAccess": {
            "type": "integer",
            "description": "Urm Access Permissions\r\nNoAccess = 0\r\nFullAccess = 2",
            "format": "int32"
          },
          "reportingAccess": {
            "type": "integer",
            "description": "Reporting Access Permissions\r\nNoAccess = 0\r\nReadOnly = 1",
            "format": "int32"
          },
          "auditAccess": {
            "type": "integer",
            "description": "Audit Access Permissions\r\nNoAccess = 0\r\nReadOnly = 1",
            "format": "int32"
          },
          "managementAccess": {
            "type": "integer",
            "description": "Management Api Access Permissions\r\nNoAccess = 0\r\nReadOnly = 1\r\nFullAccess = 2",
            "format": "int32"
          },
          "insightAccess": {
            "type": "integer",
            "description": "Insight Access Permissions\r\nNoAccess = 0\r\nFullAccess = 2",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Model of Api Accounts"
      },
      "ListItemErrorInfoModel": {
        "type": "object",
        "properties": {
          "parentTaskName": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "userId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "userAccountName": {
            "type": "string",
            "nullable": true
          },
          "initiated": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://sneakpeek-services.epm.bt3ng.com/oauth/connect/token",
            "scopes": {
              "urn:management:api": "Management API scope"
            }
          }
        }
      }
    }
  },
  "x-readme": {}
}
```