EN
Español
English
Português
    Company Detail

    Petition Details

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/company/{id}
    • Guy:GET

    • Required Headers:

    • content-type: application/json
    • X-Authorization: Bearer {token}

    URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    ⚐ EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/company/{id}


    Parameters

    Name Data type Obligatory Description
    Id Number Yes Company Identifier

    Body of the Petition

    N/A

    Examples of Uri

    • /api/v9/company/1

    Answer

    {
    "Address1": "",
    "Address2": "",
    "Address3": "",
    "CityId": 4,
    "CityName": "Cali",
    "Contact": "Servicio al cliente",
    "CountryId": 2,
    "CountryName": "Colombia",
    "Description": "Empresa Guia",
    "Email": "correo@empresaguia.com",
    "Ext": "",
    "FaxNumber": "",
    "Id": "",
    "isActive": true,
    "Location": "",
    "Mobil": "3111111111",
    "Name": "Guia",
    "Nit": "80090000909",
    "Phone1": "6022002020",
    "Phone2": "6023003030",
    "Phone3": "",
    "StatusId": "1",
    "WebSiteURL": "",
    "ProjectId": "25",
    "ConsoleType": 3,
    "RegisterType": 38
}

    Response Parameters

    Name Data type Description
    totalItems Number Total number of objects found
    content List Item listing
    hasIntegration Text Determine if the company has integrations
    Id Number User ID
    locationId Number Company Location Identifier
    Name Text Company Name
    projectId Text Associated project ID

    Error Messages

    Code HTTP status Error Message
    500 InternalServerError FailureGetCompanies