Get integration module configurations
GET/intmods
Base URL: https://api.tinkermode.com
Get the list of integration module configurations across homes. Integration modules are used to connect to external services and configurations are used to define the connection details.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user, service account, or project API key.
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
catalogTypes | string | No | Returns integration module configurations of the specified catalog types. Multiple types can be specified as a comma-separated list. | |
homeIds | string | No | Returns integration module configurations of the specified home IDs. Multiple IDs can be specified as a comma-separated list. | |
isConnected | boolean | No | If true, only return integration module configurations that are currently connected. If false, only return integration module configurations that are not connected. | |
limit | integer | No | default: 25; min: 1 | Maximum number of integration module configurations to return. |
skip | integer | No | default: 0; min: 0 | Number of integration module configurations to skip over. |
sortBy | string | No | The sort order of the configurations in the format field:order (e.g. catalogType:desc).
The supported fields are isConnected, catalogType, and homeId. The default order is
ascending.
|
Responses
200 Successful retrieval of integration module configurations.
Content type: application/json
Represents an integration module configuration created in a project.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogType | string | Yes | Catalog type of the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
claims | object | No | Claims is the definition of the authentication method and credentials for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
configId | string | Yes | read-only (server-generated) | Unique Integration Module ID. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
homeId | integer | Yes | Home that this integration module belongs to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | integer | Yes | read-only (server-generated) | Project that this integration module belongs to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule | object | No | Schedule is the definition of the schedule for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response example
[
{
"attributes": {
"attribute 1": "Value of the attribute 1",
"attribute 2": "Value of the attribute 2"
},
"catalogType": "external-service",
"claims": {
"credentials": {
"grantType": "client_credentials",
"tokenUrl": "https://auth.example.com/oauth2/token"
},
"method": "oauth2"
},
"configId": "external-service-1234",
"homeId": 1234,
"projectId": 1234,
"schedule": {
"cronSchedule": "* * * * *",
"cronTimeZone": "Asia/Tokyo",
"operations": [
{
"appConfigs": {
"defaultAttributeValues": {
"userId": "external_service_user_5678"
}
},
"operationName": "users",
"parameters": [
{
"name": "user_id",
"value": "5678"
}
]
}
]
}
}
]401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |