GET
/
api
/
v2
/
searchAccounts
Search accounts
curl --request GET \
  --url https://api.vida.dev/api/v2/searchAccounts
{
  "success": true,
  "totalAccounts": 1,
  "pageSize": 20,
  "pageNumber": 0,
  "accounts": [
    {}
  ]
}

Authorizations

​
token
string
query
required

Vida API Token

Query Parameters

​
accountType
string
required

Type of account to search

​
queryText
string

Optional free text search

​
pagination
boolean

Whether to provide pagination

​
page
number

Page number to fetch

​
pageSize
number

How many accounts per page

​
createdStart
number

Epoch to search created accounts from

​
createdEnd
number

Epoch to search created accounts until

​
canceledStart
number

Epoch to search cancellations from

​
canceledEnd
number

Epoch to search cancellations until

​
subscribed
boolean

Filter by subscription state

​
canceled
boolean

Filter by canceled subscription state

​
active
boolean

Filter by active flag

​
onboardingComplete
boolean

Filter by onboarding completed flag

​
productPlanId
string

Product plan id filter

​
productPlanTerm
string

Product plan term filter

​
billingSubscriptionId
string

Billing subscription id filter

​
billingId
string

Billing id filter

​
externalAccountId
string

External account id filter

​
currentBillingPeriodVoiceMinutesMin
number

Minimum current period voice minutes

​
currentBillingPeriodVoiceMinutesMax
number

Maximum current period voice minutes

​
previousBillingPeriodVoiceMinutesMin
number

Minimum previous period voice minutes

​
previousBillingPeriodVoiceMinutesMax
number

Maximum previous period voice minutes

​
currentBillingPeriodMessagesMin
number

Minimum current period messages

​
currentBillingPeriodMessagesMax
number

Maximum current period messages

​
previousBillingPeriodMessagesMin
number

Minimum previous period messages

​
previousBillingPeriodMessagesMax
number

Maximum previous period messages

​
allTimeVoiceMinutesMin
number

Minimum all time voice minutes

​
allTimeVoiceMinutesMax
number

Maximum all time voice minutes

​
allTimeMessagesMin
number

Minimum all time messages

​
allTimeMessagesMax
number

Maximum all time messages

Response

200 - application/json

Successful response

The response is of type object.