v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
ProviderAccounts

Search provider accounts

Search for one or more provider accounts.

get/v1/ProviderAccounts

Query parameters

search.provider_account_idinteger[]

Query by provider account identifier.

search.provider_idinteger[]

Query by provider identifier.

search.descriptionstring[]

Query by all or part of description.

search.bill_profile_idinteger[]

Query by default bill profile identifier.

search.state_provincestring[]

Query state restriction (2-character abbreviation)

search.gravity_profile_idinteger[]

Query by gravity profile identifier.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.