Pass Through
Learn how to make a pass through request to call any endpoint in any connected system.
Overview
The Maesn API supports pass through requests, enabling you to call external system endpoints even if they haven’t been explicitly implemented in our API.
This feature allows you to send authenticated requests directly through our platform by specifying the target path and providing the necessary request data.
This section explains how to structure a pass through request and outlines all supported fields.
Endpoint
Send a POST
request to:
Request Body
The body of your request should include the following fields:
path
- The relative path of the target endpoint (e.g.,
/employees
,/units
). - Do not include the full URL, only the endpoint path segment.
- If you’re unsure which portion of the URL to include, refer to the system-specific documentation below. It lists the baseUrl used for each system, allowing you to determine exactly what should be included in the path field.
method
- The HTTP method to use. Supported values are
GET
,POST
,PUT
,PATCH
, andDELETE
.
body
- Required for
POST
,PUT
, andPATCH
requests. - For REST API systems: Add all relevant fields directly inside the body object.
- For GraphQL systems: The body object must include a field named query, containing your GraphQL query as a string.
- For SOAP systems: The body object must include a field named xml, containing your XML payload as a base64-encoded string.
Headers
Include the following headers in your request:
X-API-KEY
: Your Maesn API key.
X-ACCOUNT-KEY
: Your account-specific key.
Query Parameters
If you are not using the Interactive Authentication Flow, some systems may require additional parameters:
environmentName
companyId
Refer to the system-specific documentation below to confirm whether these are required for your request.