Accounts
Accounts are passive entities that store quota information for resources consumed by associated profiles. An account is created for a user when they first sign up.
Objects
Account
| Path | JSON Type | Format | Description |
|---|---|---|---|
id | string | Version 4 UUID | The account ID |
created | string | ISO 8601 timestamp | The instant at which the account was created |
lastModified | string | ISO 8601 timestamp | The instant at which the account was last modified |
company | string | The name of the company associated with the account | |
ownerEmail | string | Email address | The email address of the owner profile |
ownerProfileId | string | The ID of the owner profile | |
maxWorkspaces | number | Unsigned integer | The maximum number of workspaces that can be created under the account |
maxRows | number | Unsigned integer | The maximum number of managed database rows available to the account |
minutesPerMonth | number | Unsigned integer | The number of pipeline run minutes available to the account per month |
minutesUsed | number | Unsigned integer | The number of pipeline run minutes used by the account per month |
maxClients | number | Unsigned integer | The number of API key clients available to the account |
Requests
View all accounts
GET /api/accounts
Returns all accounts the authenticated user profile is an owner of.
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts' -i -X GET
import requests
url = "https://app.meltano.com:443/api/accounts"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Account collection with HAL links.
{
"_embedded" : {
"accounts" : [ {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"created" : "2026-08-06T15:35:40.316956",
"lastModified" : "2026-08-06T19:28:31.262062",
"company" : "SIT Account - DO NOT CHANGE",
"ownerEmail" : "sit+prod@meltano.com",
"ownerProfileId" : "auth0|6a21dc7aa1db2e036a222942",
"maxWorkspaces" : 20,
"maxRows" : 100000,
"minutesPerMonth" : 300,
"minutesUsed" : 16,
"maxClients" : 0,
"_embedded" : {
"profiles" : {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/auth0%7C6a21dc7aa1db2e036a222942/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/auth0%7C6a21dc7aa1db2e036a222942/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
}
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/auth0%7C6a21dc7aa1db2e036a222942"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/auth0%7C6a21dc7aa1db2e036a222942"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/auth0%7C6a21dc7aa1db2e036a222942/admins"
}
}
}, {
"id" : "naeda-ypuyl",
"created" : "2026-08-06T15:36:16.462619",
"lastModified" : "2026-08-06T15:36:17.397355",
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod+2@meltano.com",
"ownerProfileId" : "auth0|6a21dcb31409cf3514bdf167",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/naeda-ypuyl"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/naeda-ypuyl/admins"
}
}
}, {
"id" : "nahaz-mxals",
"created" : "2026-08-06T18:37:46.333958",
"lastModified" : "2026-08-06T18:37:47.151548",
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod+2@meltano.com",
"ownerProfileId" : "auth0|6a21dcb31409cf3514bdf167",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/nahaz-mxals"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/nahaz-mxals/admins"
}
}
}, {
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.382355",
"lastModified" : "2026-08-07T13:18:44.382425",
"company" : "Test Company",
"ownerEmail" : "sit+prod@meltano.com",
"ownerProfileId" : "auth0|6a21dc7aa1db2e036a222942",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 4,
"totalPages" : 1,
"number" : 0
}
}
View an account
GET /api/accounts/{account-id}
Returns the account {account-id}.
Prerequisites
- Account
{account-id}must exist - The authenticated user profile must be an owner of the account
{account-id}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw' -i -X GET
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.382355",
"lastModified" : "2026-08-07T13:18:44.382425",
"company" : "Test Company",
"ownerEmail" : "sit+prod@meltano.com",
"ownerProfileId" : "auth0|6a21dc7aa1db2e036a222942",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
}
Initialise a new account
POST /api/accounts/new
Initialises a new account.
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/new' -i -X POST \
-H 'Content-Type: application/json'
import requests
url = "https://app.meltano.com:443/api/accounts/new"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.187460308",
"lastModified" : "2026-08-07T13:18:44.187461793",
"ownerEmail" : "sit+prod+2@meltano.com",
"ownerProfileId" : "auth0|6a21dcb31409cf3514bdf167",
"maxWorkspaces" : 1,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"create account" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
}
}
}
Create an account
PUT /api/accounts/{account-id}
Creates the account {account-id}.
Prerequisites
- The
ownerEmailmust match the authenticated user profile's email address
Body
Account resource.
{
"company" : "Test Company",
"ownerEmail" : "sit+prod+2@meltano.com"
}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"company" : "Test Company",
"ownerEmail" : "sit+prod+2@meltano.com"
}'
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw"
data = {
"company" : "Test Company",
"ownerEmail" : "sit+prod+2@meltano.com"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
201 Created
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.38235468",
"lastModified" : "2026-08-07T13:18:44.382424556",
"company" : "Test Company",
"ownerEmail" : "sit+prod+2@meltano.com",
"ownerProfileId" : "auth0|6a21dcb31409cf3514bdf167",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
}
Update an account
PUT /api/accounts/{account-id}
Updates the account {account-id}.
Prerequisites
- Account
{account-id}must exist - The authenticated user profile must be an owner of the account
{account-id}
Body
Account resource.
{
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod@meltano.com",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"maxClients" : 0
}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod@meltano.com",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"maxClients" : 0
}'
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw"
data = {
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod@meltano.com",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"maxClients" : 0
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.382355",
"lastModified" : "2026-08-07T13:18:45.276382758",
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod@meltano.com",
"ownerProfileId" : "auth0|6a21dc7aa1db2e036a222942",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company (updated)",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
}
View all account admins
GET /api/accounts/{account-id}/admins
Returns all admins of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins' -i -X GET
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Profile collection with HAL links.
{
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company (updated)",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
}
}
Add an account admin
PUT /api/accounts/{account-id}/admins/{profile-id}
Adds the profile {profile-id} as an admin of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must exist
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167' -i -X PUT \
-H 'Content-Type: application/json'
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.382355",
"lastModified" : "2026-08-07T13:18:45.276383",
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod@meltano.com",
"ownerProfileId" : "auth0|6a21dc7aa1db2e036a222942",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company (updated)",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
}
Remove an account admin
DELETE /api/accounts/{account-id}/admins/{profile-id}
Removes the profile {profile-id} as an admin of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must be an admin of the account{account-id}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167' -i -X DELETE
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Set an account owner
PUT /api/accounts/{account-id}/owner/{profile-id}
Sets the profile {profile-id} as the primary owner of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must be an admin of the account{account-id}
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167' -i -X PUT \
-H 'Content-Type: application/json'
import requests
url = "https://app.meltano.com:443/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Account with HAL links.
{
"id" : "rlfqb-nspdw",
"created" : "2026-08-07T13:18:44.382355",
"lastModified" : "2026-08-07T13:18:45.276383",
"company" : "Test Company (updated)",
"ownerEmail" : "sit+prod+2@meltano.com",
"ownerProfileId" : "auth0|6a21dcb31409cf3514bdf167",
"maxWorkspaces" : 0,
"maxRows" : 0,
"minutesPerMonth" : 0,
"minutesUsed" : 0,
"maxClients" : 0,
"_embedded" : {
"profiles" : [ {
"id" : "auth0|6a21dcb31409cf3514bdf167",
"name" : "sit+prod+2@meltano.com",
"handle" : "@sit+prod+2",
"email" : "sit+prod+2@meltano.com",
"workingAccount" : {
"company" : "Test Company (updated)",
"id" : "rlfqb-nspdw"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dcb31409cf3514bdf167"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dcb31409cf3514bdf167"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dcb31409cf3514bdf167"
}
}
}, {
"id" : "auth0|6a21dc7aa1db2e036a222942",
"name" : "sit+prod@meltano.com",
"handle" : "@sit+prod",
"email" : "sit+prod@meltano.com",
"workingAccount" : {
"company" : "SIT Account - DO NOT CHANGE",
"id" : "auth0|6a21dc7aa1db2e036a222942"
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/profiles"
},
"update edit profile" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942"
},
"workspaces" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"new workspace" : {
"href" : "https://app.meltano.com/api/workspaces"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account"
},
"remove account admin" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins/auth0%7C6a21dc7aa1db2e036a222942"
},
"make account owner" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/owner/auth0%7C6a21dc7aa1db2e036a222942"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw"
},
"set working account" : {
"href" : "https://app.meltano.com/api/profiles/auth0%7C6a21dc7aa1db2e036a222942/working-account/rlfqb-nspdw"
},
"admins" : {
"href" : "https://app.meltano.com/api/accounts/rlfqb-nspdw/admins"
}
}
}
Transfer a workspace
PUT /api/accounts/{account-id}/workspaces/{workspace-id}/transfer
Transfers the workspace {workspace-id} to the account {account-id}.
Prerequisites
- The user must be the owner of the account
{account-id}
Response
200 OK
Workspace with HAL links.
{
"id" : "80201bf7-cbf2-407d-9b7d-23d324115aa0",
"created" : "2026-08-07T13:18:36.706939",
"lastModified" : "2026-08-07T13:18:36.70694",
"alias" : "oacjmou",
"name" : "Test Workspace [2026-08-07T13:18:36.694962841]",
"domains" : [ ],
"repositoryUrl" : "DISABLED",
"deploymentSecret" : "ixgshwuesuznfopivcnglwyssheqvx",
"appProperties" : { },
"status" : "READY",
"managed" : true,
"settings" : [ ],
"_embedded" : {
"default datastore" : {
"id" : "1116326e-8099-40af-9218-830567db669e",
"created" : "2026-08-07T13:18:37.343226",
"lastModified" : "2026-08-07T13:18:37.343228",
"name" : "Warehouse",
"properties" : {
"password" : "rMWIhY91_Wt2fRZ0J_9J2czvRF",
"dbname" : "pnvipdv",
"default_target_schema" : "analytics",
"port" : "5432",
"host" : "db.meltano.internal",
"user" : "pnvipdv"
},
"commands" : { },
"dataPlugin" : "loaders/target-postgres--matatika",
"dataPluginType" : "loader",
"dataPluginLogoUrl" : "/assets/logos/loaders/postgres.png",
"logoUrl" : "/assets/logos/loaders/postgres.png",
"workspace" : "80201bf7-cbf2-407d-9b7d-23d324115aa0",
"jdbcUrl" : "jdbc:postgresql://db.meltano.internal:5432/pnvipdv",
"managed" : true,
"draft" : false,
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/datastores/1116326e-8099-40af-9218-830567db669e"
},
"dataplugin" : {
"href" : "https://app.meltano.com/api/dataplugins/2e7ce768-494b-4c98-811f-d2805ee7417d"
}
}
},
"state datastore" : {
"id" : "1116326e-8099-40af-9218-830567db669e",
"created" : "2026-08-07T13:18:37.343226",
"lastModified" : "2026-08-07T13:18:37.343228",
"name" : "Warehouse",
"properties" : {
"password" : "rMWIhY91_Wt2fRZ0J_9J2czvRF",
"dbname" : "pnvipdv",
"default_target_schema" : "analytics",
"port" : "5432",
"host" : "db.meltano.internal",
"user" : "pnvipdv"
},
"commands" : { },
"dataPlugin" : "loaders/target-postgres--matatika",
"dataPluginType" : "loader",
"dataPluginLogoUrl" : "/assets/logos/loaders/postgres.png",
"logoUrl" : "/assets/logos/loaders/postgres.png",
"workspace" : "80201bf7-cbf2-407d-9b7d-23d324115aa0",
"jdbcUrl" : "jdbc:postgresql://db.meltano.internal:5432/pnvipdv",
"managed" : true,
"draft" : false,
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/datastores/1116326e-8099-40af-9218-830567db669e"
},
"dataplugin" : {
"href" : "https://app.meltano.com/api/dataplugins/2e7ce768-494b-4c98-811f-d2805ee7417d"
}
}
}
},
"defaultWorkspace" : false,
"_links" : {
"self" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0"
},
"update delete workspace" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0"
},
"administrators" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/administrators"
},
"transfer" : {
"href" : "https://app.meltano.com/api/accounts/auth0%7C6a21dc7aa1db2e036a222942/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/transfer"
},
"make-default" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/default"
},
"members" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/members"
},
"news" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/news"
},
"newsTags" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/news/tags"
},
"invitations" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/invitations"
},
"create invitation" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/invitations"
},
"datasets" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datasets"
},
"publish dataset" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datasets"
},
"liked-datasets" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/liked"
},
"channels" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/channels"
},
"tags" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/tags"
},
"search" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/search"
},
"feed" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/feed"
},
"msearch" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datasets/_msearch"
},
"questions" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/questions"
},
"discovery.yml" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/discovery.yml"
},
"dataplugins" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/dataplugins"
},
"availabledataplugins" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/availabledataplugins"
},
"datacomponents" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datacomponents"
},
"datastores" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datastores"
},
"default datastore" : {
"href" : "https://app.meltano.com/api/datastores/1116326e-8099-40af-9218-830567db669e"
},
"pipelines" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/pipelines"
},
"jobs" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/jobs"
},
"new dataplugin" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/dataplugins"
},
"publish discovery.yml" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/discovery"
},
"new datacomponent" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datacomponents"
},
"new datastore" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/datastores"
},
"new pipeline" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/pipelines"
},
"add subscription" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/subscriptions"
},
"notifications" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/notifications"
},
"create deployment" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/deployments"
},
"resources" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/resources"
},
"publish resources" : {
"href" : "https://app.meltano.com/api/workspaces/80201bf7-cbf2-407d-9b7d-23d324115aa0/resources"
}
}
}