NOTE: Based on customer feedback regarding confusing functionality, the AI Search feature has been disabled. The excellent Keyword search continues to function normally. The Aspire team strives to optimizes the platform search tools to provide the best customer experience possible.

/Branches

Prev Next
Get
/Branches
Security
HTTP
Type bearer

Bearer Authorization Token

Query parameters
$select
string
$filter
string
$expand
string
$orderby
string
$skip
string
$top
string
$pageNumber
string
$limit
string
api-version
string
Responses
200
Array of object
object
BranchID
integer (int32)
BranchName
string | null
Min length0
Max length50
Active
boolean | null
InternalPropertyID
integer (int32) | null
InternalPropertyName
string | null
Min length0
Max length100
CatalogPriceListName
string | null
Min length0
Max length50
BranchAddressID
integer (int32) | null
BranchAddressLine1
string | null
Min length0
Max length75
BranchAddressLine2
string | null
Min length0
Max length75
BranchAddressCity
string | null
Min length0
Max length50
BranchAddressStateProvinceCode
string | null
Min length0
Max length3
BranchAddressZipCode
string | null
Min length0
Max length15
BranchPhone
string | null
Min length0
Max length14
BranchFax
string | null
Min length0
Max length14
BranchCode
string | null
Min length0
Max length6
BranchManagerContactID
integer (int32) | null
BranchManagerContactName
string | null
Min length0
Max length101
LegalName
string | null
Min length0
Max length100
TimeZone
string | null
Min length0
Max length50
InvoiceNumberPrefix
string | null
Min length0
Max length20
ReceiptNumberPrefix
string | null
Min length0
Max length20
OpportunityNumberPrefix
string | null
Min length0
Max length20
RegionID
integer (int32) | null
RegionName
string | null
Min length0
Max length250
BillingEmailFromAccountOwner
boolean
BillingEmailFromUserName
string | null
Min length0
Max length101
BillingEmailFromEmail
string | null
Min length0
Max length255
BillingEmailSubject
string | null
Min length0
Max length255
BillingEmailBody
string | null
Min length0
Max length2147483647
InvoiceOnCompletionDescription
string | null
Min length0
Max length2147483647
BranchWebSite
string | null
Min length0
Max length255
CatalogPriceListID
integer (int32) | null
BillingEmailCC
string | null
Min length0
Max length2147483647