Company List [GET]
Operation
Information of the operation
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/company
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
| sort | string | false | request parameter | id | Property of the entity to sort by. |
| sortMode | string | false | request parameter | Asc | Mode of sorting. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/company
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true | Description of the response of the success operation |
Entity
companyEmailList companyAddressList companyPhoneList companyTaxAddressField 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. List of CompanyEmail false List of CompanyAddress false List of CompanyPhone false CompanyTaxAddress false remark String false assignedUser User false only show: userName profileType profileType companyCustomFieldValueList List of CompanyCustomFieldValue customerProfileList List of CustomerProfile
Example response
{
"count": 1273,
"offset": 0,
"limit": 2,
"list": [
{
"id": 11,
"name": "Tesipro",
"code": TES,
"taxId": "1234",
"iataId": null,
"companyEmailList": [
{
"id": 11,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "ashawk5@cnet.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 11,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "80 Mallard Drive",
"city": "Nashville",
"stateProvName": "Tennessee",
"stateProvCode": null,
"postalCode": "37235",
"countryCode": "NC",
"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-(615)108-5804",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 1,
"communicationLocationType": null,
"street": "80 Mallard Drive",
"city": "Nashville",
"stateProvName": "Tennessee",
"stateProvCode": null,
"postalCode": "37235",
"countryCode": "WS",
"remark": "Address Remark"
},
"remark": "Company Remarks",
"assignedUser": {
"userName": "Manager"
}
},
{
"id": 12,
"name": "Wordify",
"code": null,
"taxId": "191361",
"iataId": null,
"companyEmailList": [
{
"id": 12,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "revans0@hatena.ne.jp",
"remark": null
}
],
"companyAddressList": [
{
"id": 12,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "201 Utah Terrace",
"city": "Philadelphia",
"stateProvName": "Pennsylvania",
"stateProvCode": null,
"postalCode": "19136",
"countryCode": "NU",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 12,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(215)766-7602",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 2,
"communicationLocationType": null,
"street": "201 Utah Terrace",
"city": "Philadelphia",
"stateProvName": "Pennsylvania",
"stateProvCode": null,
"postalCode": "19136",
"countryCode": "PM",
"remark": "Address Remark"
},
"remark": "Company Remarks",
"assignedUser": {
"userName": "Administrator"
},
"profileType": {
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
}
}
]
}