THE MOVEMENT API GIVES YOU ACCESS TO MAKE REQUESTS AND MANAGE RESOURCES ON YOUR APP.
By Matt Lawrie
August 14, 2023
The Movement API provides a flexible and powerful toolset for users to create, manage, and enhance their Movement platform experience. Our API currently has 11 endpoints, each serving a specific purpose and providing a unique function for the users of the API.
The API access essentially gives you the same functionality and capabilities as what you can do with the Zapier integration and the actions available there, but you can set it up directly rather than needing to go through Zapier and pay for a Zapier subscription. However, you will need to be technical to do so or have a developer that can set it up for you.
ACCESSING THE MOVEMENT API
To start, you need to be on our Business plan to access the Movement API. Once you've got that sorted, the next step is getting your hands on your API Key. This key is unique to your app, and is essential for making requests to the Movement API.
You can obtain your API Key by visiting https://my.movement.so/engage/integrations/api and using the "Copy" button to copy your key. Be careful though – anyone with this key can use the Movement App API as you. If it gets compromised, you should immediately email email@example.com to have it deactivated or changed.
MAKING YOUR FIRST API CALL
Now that you've got your API Key, you're ready to make your first API call! Every request you make must include the x-api-key header filled with your API key.
For example, to check if your API Key is set up correctly, you can make a GET call to the /me endpoint. This will return the name of the app you are authenticated as. Don't worry if you're not familiar with command line operations or cURL.
WORKING WITH API ENDPOINTS
Now let's look at some of the API calls you can make. Movement API provides several endpoints, each allowing you to manage different aspects of your app. An API call is a request made to the Movement API's endpoints. Each call is a request to perform a specific operation, and it's made using a specific HTTP method (like GET, POST, PUT) on a specific endpoint.
For example, a call to GET /api/v1/me retrieves the current app information. On the other hand, a call to POST /api/v1/members creates a new member in the app.
Each API call may require specific parameters to be included, and will return a response from the server in JSON format, which contains the result of the operation - this could be the requested data, or a status message indicating success or failure of the requested operation.
These API calls are the fundamental way you’ll interact with the Movement API. .