Introduction

Getting Started

Make your first authenticated request to the MVP One API.

Before you start

1. Get your MVP One site name.
2. Get your API key.
3. Choose a tool for sending requests, such as curl, Postman, or your HTTP client of choice.

Base URL

Use your site name in the base URL:

https://{site}.mvpplant.com

Authentication

Send either of these authentication methods with your request:

• API Key: Send your API key in the API_KEY header.
• Basic Auth: Send your MVP One username and password using Basic authentication.

API Key example

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts" \
  -H "API_KEY: your_api_key"

Basic Auth example

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts" \
  -u "your_username:your_password"

Make your first request

Start with a simple GET request to the Accounts endpoint.

Request

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts" \
  -H "API_KEY: your_api_key"

Success response

{
  "value": [
    {
      "Account": "1000",
      "Description": "Main Expense Account",
      "IsActive": true
    }
  ]
}

Try common OData queries

The MVP One API supports OData query options. Use them to select fields, filter records, sort results, and limit response size.

Select specific fields

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts?$select=Account,Description" \
  -H "API_KEY: your_api_key"

Filter records

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts?$filter=IsActive eq true" \
  -H "API_KEY: your_api_key"

Sort records

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts?$orderby=Account" \
  -H "API_KEY: your_api_key"

Limit results

curl -X GET "https://{site}.mvpplant.com/ODataApi/v1/Accounts?$top=10" \
  -H "API_KEY: your_api_key"

Understand the response format

Most GET endpoints return results in an OData response body.

Example

{
  "value": [
    {
      "Account": "1000",
      "Description": "Main Expense Account",
      "IsActive": true
    }
  ]
}

Troubleshooting

401 Unauthorized

Check that:

• your API_KEY header is included
• your API key is valid
• your API key belongs to the correct MVP One site

404 Not Found

Check that:

• the {site} value in the URL is correct
• the endpoint path is correct

400 Bad Request

Check that:

• your query string uses valid OData syntax
• field names are spelled correctly
• string values in filters are quoted correctly

Next steps

After your first request works, try these common endpoints:

• GET https://{site}.mvpplant.com/ODataApi/v1/Parts
• GET https://{site}.mvpplant.com/ODataApi/v1/PurchaseOrders
• GET https://{site}.mvpplant.com/ODataApi/v1/WorkOrders

Need help?

We're here to help if you have questions or run into issues.

• Knowledge Base: Visit our knowledge base for quick answers and troubleshooting tips.
  Knowledge Base

• Live Chat: After you log in, use the chat bubble in the bottom-right corner to talk to our support team.

• Email: Contact us at [email protected].

Our team is happy to help you get the most out of MVP One.