Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
companies

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

<Check title="Required Permissions" icon="key">The user must be an admin or have company-master-data:read permissions.</Check>

get/companies/{companyId}/contactinfo

Path parameters

companyIdstring uuid required

The id of the company.

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Headers

Authorizationstring required

Bearer authentication

Response

OK

labelstring nullable

The label of the contact info. Only necessary if type 'custom' is used.

valuestring nullable

The value of the contact info.

typestring required

The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'.

subTypestring nullable

The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other']

addressLine1string nullable

The first address line of the contact info.

addressLine2string nullable

The second address line of the contact info.

zipCodestring nullable

The zipcode of the contact info.

citystring nullable

The city of the contact info.

statestring nullable

The state of the contact info.

countrystring nullable

The 2 letter iso code of the country.

isAddressboolean

Flags whether this contact info is an address. If it's an address, the address fields are required.

idstring uuid

The Id of the contact info.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.