- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v23.1/Companies
Security
HTTP
Type Bearer
Please enter a valid token
Query parameters
Name
string
CompanyNumber
integer (int32)
UrlTag
string
IsHeadOfficeCompaniesOnly
string
Valid values[ "All", "Yes", "No" ]
IsLockedOutOnly
string
Valid values[ "All", "Yes", "No" ]
IsExpiredEvaluationOnly
string
Valid values[ "All", "Yes", "No" ]
ItemId
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
ModifiedSinceDateTime
string (date-time)
Responses
200
Success
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
countryId
integer (int32)
languageId
integer (int32)
currencyId
integer (int32)
customerId
integer (int32)
priceDecimals
integer (int32)
isHeadOffice
boolean
Default"False"
name
string
companyNumber
integer (int32)
description
string
isLockedOut
boolean
Default"False"
isIpRestrictedAccess
boolean
Default"False"
ipAddressRestrictions
string
isVatIncluded
boolean
Default"False"
twoFactor
boolean
Default"False"
urlTag
string
organizationDescription
string
organizationNumber
integer (int32)
organizationName
string
isoCountryCode
string
countryDescription
string
languageCode
string
languageDescription
string
currencyCode
string
currencyDescription
string
currencySymbolCode
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
countryId
integer (int32)
languageId
integer (int32)
currencyId
integer (int32)
customerId
integer (int32)
priceDecimals
integer (int32)
isHeadOffice
boolean
Default"False"
name
string
companyNumber
integer (int32)
description
string
isLockedOut
boolean
Default"False"
isIpRestrictedAccess
boolean
Default"False"
ipAddressRestrictions
string
isVatIncluded
boolean
Default"False"
twoFactor
boolean
Default"False"
urlTag
string
organizationDescription
string
organizationNumber
integer (int32)
organizationName
string
isoCountryCode
string
countryDescription
string
languageCode
string
languageDescription
string
currencyCode
string
currencyDescription
string
currencySymbolCode
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
countryId
integer (int32)
languageId
integer (int32)
currencyId
integer (int32)
customerId
integer (int32)
priceDecimals
integer (int32)
isHeadOffice
boolean
Default"False"
name
string
companyNumber
integer (int32)
description
string
isLockedOut
boolean
Default"False"
isIpRestrictedAccess
boolean
Default"False"
ipAddressRestrictions
string
isVatIncluded
boolean
Default"False"
twoFactor
boolean
Default"False"
urlTag
string
organizationDescription
string
organizationNumber
integer (int32)
organizationName
string
isoCountryCode
string
countryDescription
string
languageCode
string
languageDescription
string
currencyCode
string
currencyDescription
string
currencySymbolCode
string
401
Unauthorized
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403
Forbidden
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404
Not Found
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
Was this article helpful?