API Documentation
Authorization
Agents
Phone Numbers
SIP
Messaging
Webhooks
Knowledge
Accounts
- POSTCreate a new reseller
- GETList resellers
- POSTCreate a new organization
- DELDelete an organization
- GETList organizations
- GETList agent accounts
- POSTCreate a new account
- DELDelete an account
- GETList admin users
- DELDelete admin user
- POSTInvite admin user
- GETFetch Account by externalAccountId
- POSTUpdate Organization Settings
Billing
Accounts
Fetch Account by externalAccountId
Returns the account that matches the externalAccountId – Reseller/Partner only.
GET
/
api
/
v2
/
getAccountByExternalId
Copy
Ask AI
curl --request GET \
--url https://api.vida.dev/api/v2/getAccountByExternalId
Copy
Ask AI
{
"success": true,
"message": "Success",
"account": {
"id": 3,
"username": "accountUsername",
"organizationId": 3
}
}
Authorizations
Vida API Token
Query Parameters
Your system’s customer / account ID
Response
200
application/json
Account found
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://api.vida.dev/api/v2/getAccountByExternalId
Copy
Ask AI
{
"success": true,
"message": "Success",
"account": {
"id": 3,
"username": "accountUsername",
"organizationId": 3
}
}
Assistant
Responses are generated using AI and may contain mistakes.