{
  "opencollection": "1.0.0",
  "info": {
    "name": "VOLTERAS CONNECT Accounts API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.volteras.com/v1/accounts",
            "params": [
              {
                "name": "maxPageSize",
                "value": "",
                "type": "query",
                "description": "Max size of the returned list."
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "Page token used for pagination."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Listing filter schema."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve a paginated list of active accounts associated with the current organization.\n\n_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR"
        },
        {
          "info": {
            "name": "Get Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.volteras.com/v1/accounts/:account_id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve account details by providing its unique identifier.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR"
        },
        {
          "info": {
            "name": "Action Connect",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.volteras.com/v1/accounts:connect",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Generate a URL to initiate the account connection flow, which allows users to connect their accounts.\nThe generated URL is active for a **one-hour period**. If not authenticated within this timeframe, the link will become invalid.\n\nAfter the connection flow is completed, the device owner is redirected to the provided return URL with the following parameters:\n- `result` indicating success or failure.\n- `accountId` representing the ID of the connected account.\n\nFor further customization and integr"
        },
        {
          "info": {
            "name": "Action Disconnect",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.volteras.com/v1/accounts/:account_id:disconnect",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This endpoint allows you to disconnect an account.\nUpon successful disconnection, the account's connection is terminated.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR"
        }
      ]
    }
  ],
  "bundled": true
}