Integration

Retrieve Integration

GET

Retrieves an Integration specified by a unique identifier.

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

integrationIdstringRequired
The unique identifier of this Integration

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
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.
GET
$curl /api/data/integrations/integrationId \
>     -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    "id": "id",
14    "name": "name",
15    "description": "description",
16    "shortId": "shortId",
17    "isMultiInstance": true,
18    "config": {
19      "key": "value"
20    },
21    "licenseSkus": [
22      "licenseSkus"
23    ],
24    "instances": [
25      {}
26    ],
27    "enabled": true,
28    "authenticated": true,
29    "autoEnabled": true
30  }
31}
Built with