Company by ID [GET]

Operation

This endpoint returns the information of a company given an specific company ID

Information of the operation

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/company/{companyId}

Request

Property	Type	Required	Path parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
companyId	Integer	true	path parameter		The company to retrieve.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/company/11

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	int	false	Id of the Company.
name	string	true	Name of the Company.
code	string	true	Generated code from the name of the company.
taxId	string	true	TaxId of the Company.
companyEmailList	List of CompanyEmail	false
companyAddressList	List of CompanyAddress	false
companyPhoneList	List of CompanyPhone	false
companyTaxAddress	CompanyTaxAddress	false
remark	String	false
assignedUser	User	false	only show: userName
profileType	profileType
companyCustomFieldValueList	List of CompanyCustomFieldValue
customerProfileList	List of CustomerProfile

Example response

{
  "id": 11,
  "name": "Tesipro",
  "code": null,
  "taxId": "1234",
  "iataId": null,
  "companyEmailList": [
    {
      "id": 11,
      "primary": true,
      "emailAddressType": {
        "id": 1,
        "code": "1",
        "name": "Personal"
      },
      "email": "lrossre@microsoft.com",
      "remark": null
    }
  ],
  "companyAddressList": [
    {
      "id": 11,
      "primary": true,
      "communicationLocationType": {
        "id": 1,
        "code": "1",
        "name": "Home"
      },
      "street": "9 Colorado Junction",
      "city": "Sacramento",
      "stateProvName": "Ciudad Real",
      "stateProvCode": "ES-CR",
      "postalCode": "95818",
      "countryCode": "ES",
      "remark": "Address Remark"
    }
  ],
  "companyPhoneList": [
    {
      "id": 11,
      "primary": true,
      "phoneLocationType": {
        "id": 6,
        "code": "6",
        "name": "Home"
      },
      "phoneTechType": {
        "id": 1,
        "code": "1",
        "name": "Voice"
      },
      "countryAccessCode": "+34",
      "areaCityCode": "B",
      "phoneNumber": "1-(530)311-9303",
      "extension": "1",
      "remark": "Phone Remark"
    }
  ],
  "companyTaxAddress": {
    "id": 1,
    "communicationLocationType": null,
    "street": "9 Colorado Junction",
    "city": "Sacramento",
    "stateProvName": "Orense",
    "stateProvCode": "ES-OR",
    "postalCode": "95818",
    "countryCode": "ES",
    "remark": "Address Remark"
  },
  "remark": "Company Remarks",
  "profileType": {
	 "code": "2",
   	 "name": "Company",
     "nameI18n": "Company",
     "colorCode": "#00ACC1"
   }
}