Get account information
Get your account in one call with GET /v2/users/me: profile, plan, memory usage and every application and database you own, ready for an overview page.
GET
/
v2
/
users
/
me
Get account information
curl --request GET \
--url https://api.squarecloud.app/v2/users/me \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/me"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/users/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/users/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/users/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/users/me")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/users/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"user": {
"id": "123456789012345678",
"name": "John Doe",
"email": "john@example.com",
"plan": {
"name": "standard-4",
"memory": {
"limit": 4096,
"available": 3840,
"used": 256
},
"duration": 1732072955446
},
"created_at": "2022-01-10T12:00:00Z"
},
"applications": [
{
"name": "Square Example APP",
"id": "446b0b4118634a1c99e73bac9a54e475",
"desc": "This is a example of description",
"ram": 512,
"lang": "javascript",
"domain": "square-example-app.squareweb.app",
"custom": "mydomain.com",
"cluster": "suki-cluster",
"created_at": "2023-02-20T14:30:00Z"
}
],
"databases": [
{
"id": "db1234567890",
"name": "example-database",
"type": "mongodb",
"cluster": "suki-cluster",
"ram": 1024,
"created_at": "2023-01-15T10:00:00Z"
}
]
}
}
The API key for your account. You can find this in your account settings.
account:read scope.
Account Information returns everything about your own Square Cloud account in a single call: profile, plan and memory usage, and every application and database you own. It’s a good root call for dashboards or CLI tools that need to render an account overview without querying each application and database individually.
The response is scoped to the authenticated token; there is no way to request another account’s data through this route. Applications include their domain and cluster, and databases include their type and RAM, both enough to build a listing UI without extra roundtrips.
To drill into a single application instead, see Get Application Info; for the account’s backups, see List Snapshots.
Response
The response content.
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
{
"status": "success",
"response": {
"user": {
"id": "123456789012345678",
"name": "John Doe",
"email": "john@example.com",
"plan": {
"name": "standard-4",
"memory": {
"limit": 4096,
"available": 3840,
"used": 256
},
"duration": 1732072955446
},
"created_at": "2022-01-10T12:00:00Z"
},
"applications": [
{
"name": "Square Example APP",
"id": "446b0b4118634a1c99e73bac9a54e475",
"desc": "This is a example of description",
"ram": 512,
"lang": "javascript",
"domain": "square-example-app.squareweb.app",
"custom": "mydomain.com",
"cluster": "suki-cluster",
"created_at": "2023-02-20T14:30:00Z"
}
],
"databases": [
{
"id": "db1234567890",
"name": "example-database",
"type": "mongodb",
"cluster": "suki-cluster",
"ram": 1024,
"created_at": "2023-01-15T10:00:00Z"
}
]
}
}
Related
- CLI:
squarecloud auth whoami - SDKs:
api.account.me()(JavaScript),client.account.me()(Python),c.Account.Me()(Go)
⌘I
Get account information
curl --request GET \
--url https://api.squarecloud.app/v2/users/me \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/me"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/users/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/users/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/users/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/users/me")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/users/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"user": {
"id": "123456789012345678",
"name": "John Doe",
"email": "john@example.com",
"plan": {
"name": "standard-4",
"memory": {
"limit": 4096,
"available": 3840,
"used": 256
},
"duration": 1732072955446
},
"created_at": "2022-01-10T12:00:00Z"
},
"applications": [
{
"name": "Square Example APP",
"id": "446b0b4118634a1c99e73bac9a54e475",
"desc": "This is a example of description",
"ram": 512,
"lang": "javascript",
"domain": "square-example-app.squareweb.app",
"custom": "mydomain.com",
"cluster": "suki-cluster",
"created_at": "2023-02-20T14:30:00Z"
}
],
"databases": [
{
"id": "db1234567890",
"name": "example-database",
"type": "mongodb",
"cluster": "suki-cluster",
"ram": 1024,
"created_at": "2023-01-15T10:00:00Z"
}
]
}
}

