Returns the contact infos of the company with the specified id.

GET

Returns the contact infos of the company with the specified id.

Required Permissions: The user must be an admin or have company-master-data:read permissions.

Path parameters

companyIdstringRequired
The id of the company.

Query parameters

pageintegerOptional
Page number for pagination
pageSizeintegerOptional
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

This endpoint returns a list of objects
typestring
The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'.
labelstringOptional
The label of the contact info. Only necessary if type 'custom' is used.
valuestringOptional
The value of the contact info.
subTypestringOptional
The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other']
addressLine1stringOptional
The first address line of the contact info.
addressLine2stringOptional
The second address line of the contact info.
zipCodestringOptional
The zipcode of the contact info.
citystringOptional
The city of the contact info.
statestringOptional
The state of the contact info.
countrystringOptional
The 2 letter iso code of the country.
isAddressbooleanOptional
Flags whether this contact info is an address. If it's an address, the address fields are required.
idstringOptional
The Id of the contact info.
createdOndatetimeOptional
The date this entity was created.
createdBystringOptional
The id of the user who created this entity.
updatedOndatetimeOptional
The date this entity was last modified.
updatedBystringOptional
The id of the user who last modified this entity.
Built with