Integration Provider

Activate Integration Provider

POST

Activates an Integration Provider and retrieves authentication information about a specific IntegrationProvider.

An IntegrationProvider is the name of an external application or service that can be connected to ProjectManager.com. The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager’s sales team to request use of this API.

Path parameters

providerIdstringRequired
The unique identifier of the IntegrationProvider for which you are requesting authentication information

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
This class contains the URL or AuthScheme to use to authenticate with the Integration Provider.
POST
$curl -X POST /api/data/integrations/providers/providerId \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "connected": true,
14    "url": "url"
15  }
16}
Built with