Company resource

Methods

  • get - Get company
  • get - List companies (paginated)

Resource

{
    "addressCity": {
        "administrativeAreaLevel2": {
            "administrativeAreaLevel1": {
                "country": {
                    "code": "string",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "id": "integer",
            "name": "string"
        },
        "id": "integer",
        "latitude": "number",
        "longitude": "number",
        "name": "string",
        "navigationArea": {
            "country": {
                "code": "string",
                "name": "string"
            },
            "id": "integer",
            "name": "string"
        },
        "postalCode": "string"
    },
    "addressPostalCode": "string",
    "addressStreet1": "string",
    "addressStreet2": "string",
    "companyBrandName": "string",
    "companyContactEmail": "email",
    "companyContactPhone": {},
    "companyLegalForm": {
        "id": "integer",
        "name": "string"
    },
    "companyLegalReason": "string",
    "companyLogo": "string",
    "companySiretNumber": "string",
    "companyVatNumber": "string",
    "companyWebsiteUrl": "uri",
    "id": "integer"
}

Properties

Name Type Description Additional
addressCity object Optional, read only.
addressCity.administrativeAreaLevel2 object Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1 object Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country object Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country.code string

Country code

 Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country.name string

Country name

 Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1.id integer

Administrative area level 1 ID

 Optional, read only.
addressCity.administrativeAreaLevel2.administrativeAreaLevel1.name string

Administrative area level 1 name

 Optional, read only.
addressCity.administrativeAreaLevel2.id integer

Administrative area level 2 ID

 Optional, read only.
addressCity.administrativeAreaLevel2.name string

Administrative area level 2 name

 Optional, read only.
addressCity.id integer

City ID

 Optional, read only.
addressCity.latitude number

Geographical latitude of the city position

 Optional, read only.
addressCity.longitude number

Geographical longitude of the city position

 Optional, read only.
addressCity.name string

City name

 Optional, read only.
addressCity.navigationArea object Optional, read only.
addressCity.navigationArea.country object Optional, read only.
addressCity.navigationArea.country.code string

Country code

 Optional, read only.
addressCity.navigationArea.country.name string

Country name

 Optional, read only.
addressCity.navigationArea.id integer

Navigation area ID

 Optional, read only.
addressCity.navigationArea.name string

Navigation area name

 Optional, read only.
addressCity.postalCode string

City postal code

 Optional, read only.
addressPostalCode string

Postal code

 Optional, read only.
addressStreet1 string

Address street 1

 Optional, read only.
addressStreet2 string

Address street 2

 Optional, read only.
companyBrandName string

Brand name

 Optional, read only.
companyContactEmail email

Contact Email

 Optional, read only.
companyContactPhone object Optional, read only.
companyLegalForm object

Company type

 Optional
companyLegalForm.id integer

Element ID

 Optional, read only.
companyLegalForm.name string

Legal form name

 Optional, read only.
companyLegalReason string

Legal reason

 Optional, read only.
companyLogo string

Logo file path

 Optional, read only.
companySiretNumber string

Siret number

 Optional, read only.
companyVatNumber string

Vat identification number

 Optional, read only.
companyWebsiteUrl uri

Website Url

 Optional, read only.
id integer

Company ID.

 Optional, read only.