Back to Mavenlink.com Blog Tour Status

Mavenlink API Overview

Default Account Permissions: Account Administrator 

 

 

What is an API?

API is an abbreviation for Application Programming Interface. In Mavenlink, it is one of the two layers of the application that enables you to view, create, update, and delete the data in your account(s). The User Interface (UI) is the other layer that allows you to interact in the application, and is largely built on top of our API layer. For example, if you update an account member's name in the UI, the underlying API request being made to accomplish that is the Updating an Existing User endpoint.

In the endpoint URL the request is sent to, replace {id} with the ID number of the user whose name you want to update: https://api.mavenlink.com/api/v1/users/{id}

To learn more about Mavenlink's RESTful API based on HTTPS requests and JSON responses, see our API documentation.

Who is it for? What can I do with it?

In order to use (or consume) the Mavenlink API, you must have Account Administrator permissions in your Mavenlink account. If you are not an Account Administrator, you cannot register applications to interact with your Mavenlink account. Registering an application means you are approving an application to communicate with your Mavenlink account. And if you cannot register applications, you do not have the OAuth2[external reference icon] token(s) required for authentication of requests to the Mavenlink API. You can think of OAuth2 tokens as the credentials that enable external applications to securely communicate with Mavenlink.

TIP

You can also view and manage your authorized tokens under Password & Authorizations settings.2020-12-04_12-24-19.gif

Because our API provides access to the majority of our data model, you can do just about anything in the Mavenlink application with it. It is a very powerful tool, and the OAuth 2 protocol enables application developers to request permissions and interact with your Mavenlink data in a secure manner.

Our vast API means three things for our clients, developers, and partners:

  1. You can completely customize your own Mavenlink environment if you want to.
  2. You can automate actions and workflows in Mavenlink itself, or between Mavenlink and third-party applications via your own scripts.

    WHAT THE MAVENS KNOW

    If you aren't comfortable with writing your own scripts, but still interested in automating workflows, we've got you covered! Our M-Bridge Workflows platform leverages the APIs of both Mavenlink and third-party applications to provide you a dynamic but accessible and friendly tool that does this.

  3. Mavenlink functions can easily be integrated into other applications in a countless number of ways.

Let's take a look at some common use cases you might have as a client, partner, or developer.

Consumer Definition
Clients: Organizations and teams continually choose Mavenlink as their platform for all their core planning, project accounting, analysis, collaboration and project management functions. Clients can customize everything from fields to the branding of their Mavenlink environments from within the UI, but the possibilities for customization of environments are almost endless with the API. Everything you see in the default UI can be completely rebuilt and redesigned as needed or wanted, including the addition or removal of functions (as permitted by the API).

Developers: Developers and their organizations often have diverse and evolving needs when it comes to creating and maintaining automated business process workflows, out-of-the-box integrations, and completely custom-built integrations with HRIS applications, CRMs, ERPs, and more. Mavenlink aims to facilitate as smooth and scalable an integration experience as possible.

Partners: Organizations can make the use of Mavenlink functions a seamless option from within their own applications.

If you're ready to get started, register your application and head over to the Mavenlink developer site for our API documentation.

If you've got any feedback or questions, email us at support@mavenlink.com. Let us know what additional features you might like to see in our API. Our API is continuously improving and growing to better serve our users' needs.

 

Related Articles

Created on