GET Customers?includeDisabled={includeDisabled}

Gets all Companies in the system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeDisabled

When true, disabled Customers can be returned in the result set

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of all Companies in the system

Collection of OutputCustomerModel
NameDescriptionTypeAdditional information
CustomerID

integer

None.

ParentCustomerID

integer

None.

IsDisabled

boolean

None.

ChildCustomers

Collection of OutputCustomerModel

None.

ReportingUserName

string

None.

TableauUserName

string

None.

Name

string

Required

Max length: 128

TimeZone

TimeZoneModel

Required

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.