Download OpenAPI specification:
Automatically generated swagger spec for the user stack.
required | Array of objects (portalAddLinkEntry) |
{- "links": [
- {
- "name": "string",
- "referenceId": "string",
- "url": "string"
}
]
}{- "links": [
- {
- "id": "string",
- "name": "string",
- "referenceId": "string",
- "url": "string"
}
]
}| accountIds required | Array of strings <int64> [ items <int64 > ] |
| enable required | boolean |
| propertyIds required | Array of strings |
{- "accountIds": [
- "string"
], - "enable": true,
- "propertyIds": [
- "string"
]
}{ }{- "data": [
- {
- "entries": [
- {
- "mediumId": "string",
- "mimeType": "string",
- "name": "string",
- "objectName": "string",
- "size": 0,
- "type": "OTHER",
- "uploadedAt": "string",
- "url": "string",
- "validUntil": "string"
}
], - "id": "string",
- "links": [
- {
- "id": "string",
- "name": "string",
- "referenceId": "string",
- "url": "string"
}
], - "subTitle": "string",
- "title": "string"
}
]
}{- "groups": [
- {
- "entries": [
- {
- "mediumId": "string",
- "mimeType": "string",
- "name": "string",
- "objectName": "string",
- "size": 0,
- "type": "OTHER",
- "uploadedAt": "string",
- "url": "string",
- "validUntil": "string"
}
], - "id": "string",
- "subTitle": "string",
- "title": "string"
}
]
}| referenceIds required | Array of strings |
{- "referenceIds": [
- "string"
]
}{- "links": [
- {
- "id": "string",
- "name": "string",
- "referenceId": "string",
- "url": "string"
}
]
}required | Array of objects (portalLink) |
{- "links": [
- {
- "id": "string",
- "name": "string",
- "referenceId": "string",
- "url": "string"
}
]
}{ }required | object (usercommonv2Company) |
required | object (usercommonv2Individual) |
| subType required | string (commonv2SubType) Default: "UNDEFINED" Enum: "UNDEFINED" "TENANT" "LANDLORD" "SERVICE_PROVIDER" "MARKETING" "OWNER" "LANDLORD_MARKETING" "ACCOUNTING" "LANDLORD_ACCOUNTING" "MARKETING_ACCOUNTING" "LANDLORD_MARKETING_ACCOUNTING" "ASSET_MANAGEMENT" "ASSET_LANDLORD" "ASSET_MARKETING" "ASSET_ACCOUNTING" "ASSET_LANDLORD_MARKETING" "ASSET_LANDLORD_ACCOUNTING" "ASSET_MARKETING_ACCOUNTING" "ASSET_LANDLORD_MARKETING_ACCOUNTING" |
| type required | string (usercommonv2Type) Default: "INDIVIDUAL" Enum: "INDIVIDUAL" "COMPANY" "PLATFORM_EMPLOYEE" |
{- "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}| page required | integer <int32> Page to load. Defaults to 1 |
| perPage | integer <int32> Items per page to load. Defaults to 10 |
| types | Array of strings Items Enum: "INDIVIDUAL" "COMPANY" "PLATFORM_EMPLOYEE" The type to filter for |
| subTypes | Array of strings Items Enum: "UNDEFINED" "TENANT" "LANDLORD" "SERVICE_PROVIDER" "MARKETING" "OWNER" "LANDLORD_MARKETING" "ACCOUNTING" "LANDLORD_ACCOUNTING" "MARKETING_ACCOUNTING" "LANDLORD_MARKETING_ACCOUNTING" "ASSET_MANAGEMENT" "ASSET_LANDLORD" "ASSET_MARKETING" "ASSET_ACCOUNTING" "ASSET_LANDLORD_MARKETING" "ASSET_LANDLORD_ACCOUNTING" "ASSET_MARKETING_ACCOUNTING" "ASSET_LANDLORD_MARKETING_ACCOUNTING" The type to filter for |
string Email to filter for (optional) | |
| companyName | string Company name to filter for (optional) |
| contactPersonName | string Contact person name to filter for (optional) |
| states | Array of strings Items Enum: "UNDEFINED_STATE" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" Optional: All given states need to be part of marketing OR management |
{- "accounts": [
- {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
], - "pageCount": 0,
- "totalCount": 0
}| ids required | Array of strings <int64> non-empty [ items <int64 > ] |
{- "accounts": [
- {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
]
}| id required | string <int64> |
| billable | boolean |
object (Represents a whole or partial calendar date, such as a birthday. The time of
day and time zone are either specified elsewhere or are insignificant. The
date is relative to the Gregorian Calendar. This can represent one of the
following:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
| |
| billingAddressAccountId | string <int64> |
object (Represents a whole or partial calendar date, such as a birthday. The time of
day and time zone are either specified elsewhere or are insignificant. The
date is relative to the Gregorian Calendar. This can represent one of the
following:)
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
| |
| note | string |
| pricingModel | string (v2PricingModel) Default: "UNDEFINED_PRICING_MODEL" Enum: "UNDEFINED_PRICING_MODEL" "SAAS_PRICING_MODEL" "LICENSE_PRICING_MODEL" "SAAS_AND_LICENSE_PRICING_MODEL" |
{- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}{ }| id required | string <int64> |
| subType | string (commonv2SubType) Default: "UNDEFINED" Enum: "UNDEFINED" "TENANT" "LANDLORD" "SERVICE_PROVIDER" "MARKETING" "OWNER" "LANDLORD_MARKETING" "ACCOUNTING" "LANDLORD_ACCOUNTING" "MARKETING_ACCOUNTING" "LANDLORD_MARKETING_ACCOUNTING" "ASSET_MANAGEMENT" "ASSET_LANDLORD" "ASSET_MARKETING" "ASSET_ACCOUNTING" "ASSET_LANDLORD_MARKETING" "ASSET_LANDLORD_ACCOUNTING" "ASSET_MARKETING_ACCOUNTING" "ASSET_LANDLORD_MARKETING_ACCOUNTING" |
{- "subType": "UNDEFINED"
}{ }| id required | string <int64> |
object (typeColor) Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness. For example, the fields of this representation
can be trivially provided to the constructor of This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java):
Example (iOS / Obj-C):
Example (JavaScript):
| |
| family | string |
| size | string |
{- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "family": "string",
- "size": "string"
}{ }| id required | string <int64> |
| logoUrl | string |
{- "logoUrl": "string"
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}| id required | string <int64> |
object (usercommonv2Company) |
{- "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}| id required | string <int64> |
object (useraccountv2ContactPerson) |
{- "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}| id required | string <int64> |
object (usercommonv2Individual) |
{- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}| id required | string <int64> |
| accountingStates | Array of strings (addressState) Items Enum: "UNDEFINED_STATE" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" |
| assetStates | Array of strings (addressState) Items Enum: "UNDEFINED_STATE" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" |
| managementStates | Array of strings (addressState) Items Enum: "UNDEFINED_STATE" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" |
| marketingStates | Array of strings (addressState) Items Enum: "UNDEFINED_STATE" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" |
{- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
]
}{- "account": {
- "accountingStates": [
- "UNDEFINED_STATE"
], - "assetStates": [
- "UNDEFINED_STATE"
], - "billing": {
- "billable": true,
- "billableSetDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "billingAddressAccountId": "string",
- "contractStart": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "lastModifiedBy": "string",
- "lastModifiedDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "note": "string",
- "pricingModel": "UNDEFINED_PRICING_MODEL"
}, - "company": {
- "aboutUs": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "vatNumber": "string",
- "website": "string"
}, - "contactPerson": {
- "email": "string",
- "name": "string",
- "phone": "string",
- "userId": "string"
}, - "createdAt": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "id": "string",
- "individual": {
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "email": "string",
- "firstName": "string",
- "gender": "UNDEFINED_GENDER",
- "lastName": "string",
- "phoneNumber": "string",
- "website": "string"
}, - "logoUrl": "string",
- "managementStates": [
- "UNDEFINED_STATE"
], - "marketingStates": [
- "UNDEFINED_STATE"
], - "subType": "UNDEFINED",
- "type": "INDIVIDUAL"
}
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| accountId required | string <int64> (The accountId to which the user should be invited) |
| email required | string |
| firstName required | string |
| lastName required | string |
| password required | string (Optional as it can only be set if platform_employee type) |
| roles required | Array of strings |
| sendPasswordReset required | boolean |
{- "accountId": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "password": "string",
- "roles": [
- "string"
], - "sendPasswordReset": true
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| page | integer <int32> Starting from 1 |
| itemsPerPage | integer <int32> |
| accountId | string <int64> |
string | |
| firstName | string |
| lastName | string |
{- "itemsPerPage": 0,
- "overallCount": 0,
- "page": 0,
- "pageCount": 0,
- "users": [
- {
- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}
]
}| accountIds required | Array of strings <int64> [ items <int64 > ] |
{- "accountIds": [
- "string"
]
}{- "employees": [
- {
- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}
]
}| accountId required | string <int64> Coozzy account ID |
{- "employees": [
- {
- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}
]
}| userId required | string |
| role | string |
{- "role": "string"
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| userId required | string |
| newEmail | string |
{- "newEmail": "string"
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| userId required | string |
| newPassword | string |
{- "newPassword": "string"
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| userId required | string |
| role | string |
{- "role": "string"
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| userId required | string |
object (userv2Profile) |
{- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}
}{- "accountId": "string",
- "address": {
- "careOf": "string",
- "city": "string",
- "country": "string",
- "geo": {
- "elevation": 0.1,
- "latitude": 0.1,
- "longitude": 0.1
}, - "mailbox": "string",
- "state": "string",
- "street": "string",
- "streetAddition": "string",
- "streetNumber": "string",
- "subUnit": "string",
- "zip": "string"
}, - "blocked": true,
- "createdAt": "string",
- "deleted": true,
- "email": "string",
- "id": "string",
- "profile": {
- "birthday": "string",
- "color": {
- "alpha": 0.1,
- "blue": 0.1,
- "green": 0.1,
- "red": 0.1
}, - "firstName": "string",
- "gender": "UNDEFINED",
- "hourlyRate": 0.1,
- "job": "string",
- "language": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "pictureUrl": "string",
- "signatureAuthorization": "SIGNATURE_AUTHORIZATION_UNDEFINED",
- "signatureMediaId": "string"
}, - "roles": [
- "string"
]
}| documentId required | string |
| sourceAccountId required | string <int64> |
| targetAccountId required | string <int64> |
{- "documentId": "string",
- "sourceAccountId": "string",
- "targetAccountId": "string"
}{- "partnerDocuments": {
- "documentIds": [
- "string"
], - "sourceAccountId": "string",
- "targetAccountId": "string"
}
}| message required | string |
| messageEn required | string |
| messageIt required | string |
{- "message": "string",
- "messageEn": "string",
- "messageIt": "string"
}{ }{- "settings": {
- "channels": [
- "NOTIFICATION_CHANNEL_EMAIL"
], - "marketbaseNotifications": {
- "newRegistration": true,
- "newRequest": true,
- "newResponse": true,
- "viewingAppointmentsScheduled": true
}, - "otherNotifications": {
- "depositConfirmationReceived": true,
- "firstcautionDepositConfirmationReceived": true
}, - "ticketNotifications": {
- "assigned": true,
- "comments": true,
- "created": true,
- "deleted": true,
- "eventCreated": true,
- "externalInvoiceAdded": true,
- "invoiceAdded": true,
- "mailReceived": true,
- "mailSent": true,
- "overdue": true,
- "statusChanged": true,
- "updated": true
}, - "userId": "string"
}
}| channels required | Array of strings (v2NotificationChannel) Items Enum: "NOTIFICATION_CHANNEL_EMAIL" "NOTIFICATION_CHANNEL_PUSH" |
required | object (v2MarketbaseNotifications) |
required | object (v2OtherNotifications) |
required | object (v2TicketNotifications) |
| userId required | string |
{- "channels": [
- "NOTIFICATION_CHANNEL_EMAIL"
], - "marketbaseNotifications": {
- "newRegistration": true,
- "newRequest": true,
- "newResponse": true,
- "viewingAppointmentsScheduled": true
}, - "otherNotifications": {
- "depositConfirmationReceived": true,
- "firstcautionDepositConfirmationReceived": true
}, - "ticketNotifications": {
- "assigned": true,
- "comments": true,
- "created": true,
- "deleted": true,
- "eventCreated": true,
- "externalInvoiceAdded": true,
- "invoiceAdded": true,
- "mailReceived": true,
- "mailSent": true,
- "overdue": true,
- "statusChanged": true,
- "updated": true
}, - "userId": "string"
}{- "settings": {
- "channels": [
- "NOTIFICATION_CHANNEL_EMAIL"
], - "marketbaseNotifications": {
- "newRegistration": true,
- "newRequest": true,
- "newResponse": true,
- "viewingAppointmentsScheduled": true
}, - "otherNotifications": {
- "depositConfirmationReceived": true,
- "firstcautionDepositConfirmationReceived": true
}, - "ticketNotifications": {
- "assigned": true,
- "comments": true,
- "created": true,
- "deleted": true,
- "eventCreated": true,
- "externalInvoiceAdded": true,
- "invoiceAdded": true,
- "mailReceived": true,
- "mailSent": true,
- "overdue": true,
- "statusChanged": true,
- "updated": true
}, - "userId": "string"
}
}