Retrieve the MYOB Acumatica Version and the List of Endpoints

To obtain the MYOB Acumatica version and the list of contract-based endpoints available in this version by using the REST API, you access the needed URL with the GET HTTP method. The remainder of this topic provides details on the request and the response.

If the request is sent without the authentication information, the list contains only the endpoints available in the system by default. If the request is sent with the authentication information for a particular tenant, the list also includes the custom endpoints configured in this tenant of the MYOB Acumatica instance.

HTTP Method and URL

To retrieve the MYOB Acumatica version and the list of contract-based endpoints available in this version, you use the GET HTTP method and the following URL.

GET http://<MYOB Acumatica instance URL>/entity

In this URL, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance for which you want to obtain information about the version and endpoints.

For example, suppose that you work with a local MYOB Acumatica instance with the name AcumaticaDB. You would use the following URL to retrieve the information.

GET http://localhost/AcumaticaDB/entity

Parameters

You use no parameters when you retrieve the MYOB Acumatica version and the list of contract-based endpoints available in this version.

Request Headers

You can specify the following header in the request.


Header	Description
Accept	Optional. Specifies the format of the response body, which can be application/json.

Response Status Codes

The following table lists the HTTP status codes that the system returns for a request that retrieves the MYOB Acumatica version and the list of endpoints.


Code	Description
200	The request has been completed successfully. The response body contains the MYOB Acumatica version and the list of contract-based endpoints available in this version.
429	The number of requests has exceeded the limit imposed by the license (see License Restrictions for API Users).
500	An internal server error has occurred.

Example

The following request obtains the Acumatica ERP version and the list of contract-based endpoints available in this version.

Tip:

In the request example below, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance (such as https://my.acumatica.com/MyInstance). You can omit the instance name in the URL (that is, you can use https://my.acumatica.com) if the instance is installed in the root of the website.

GET /entity HTTP/1.1
Host: [<MYOB Acumatica instance URL>]
Accept: application/json

Following is an example of a response in JSON format.

{
    "version": {
        "acumaticaBuildVersion": "24.093.0064",
        "databaseVersion": "24.093.0064"
    },
    "endpoints": [
        {
            "name": "Default",
            "version": "20.200.001",
            "href": "/2024R1/entity/Default/20.200.001/"
        },
        {
            "name": "eCommerce",
            "version": "20.200.001",
            "href": "/2024R1/entity/eCommerce/20.200.001/"
        },
        {
            "name": "MANUFACTURING",
            "version": "20.200.001",
            "href": "/2024R1/entity/MANUFACTURING/20.200.001/"
        },
        {
            "name": "Velixo",
            "version": "20.200.001",
            "href": "/2024R1/entity/Velixo/20.200.001/"
        },
        {
            "name": "MANUFACTURING",
            "version": "21.200.001",
            "href": "/2024R1/entity/MANUFACTURING/21.200.001/"
        },
        {
            "name": "Default",
            "version": "22.200.001",
            "href": "/2024R1/entity/Default/22.200.001/"
        },
        {
            "name": "eCommerce",
            "version": "22.200.001",
            "href": "/2024R1/entity/eCommerce/22.200.001/"
        },
        {
            "name": "GLConsolidation",
            "version": "22.200.001",
            "href": "/2024R1/entity/GLConsolidation/22.200.001/"
        },
        {
            "name": "MANUFACTURING",
            "version": "23.100.001",
            "href": "/2024R1/entity/MANUFACTURING/23.100.001/"
        },
        {
            "name": "Default",
            "version": "23.200.001",
            "href": "/2024R1/entity/Default/23.200.001/"
        },
        {
            "name": "DeviceHub",
            "version": "23.200.001",
            "href": "/2024R1/entity/DeviceHub/23.200.001/"
        },
        {
            "name": "eCommerce",
            "version": "23.200.001",
            "href": "/2024R1/entity/eCommerce/23.200.001/"
        },
        {
            "name": "MANUFACTURING",
            "version": "23.200.001",
            "href": "/2024R1/entity/MANUFACTURING/23.200.001/"
        }
    ]
}