{
  "result": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "name": [
      "string",
      "null"
    ],
    "vendor": "BUILDIUM",
    "active": "boolean",
    "system": "PRODUCTION",
    "max_job_concurrency": "number",
    "max_request_frequency": "number",
    "max_request_cadence": "MINUTE",
    "base_url": [
      "string",
      "null"
    ],
    "customer_id": "string",
    "is_archived": "boolean",
    "ping_results": "object"
  }
}

​
Body

integration_vendorrequired
string

The integration vendor

Available options:
BUILDIUM,
ENTRATA,
PROPERTYWARE,
REALPAGE,
RENTMANAGER,
RENTVINE,
REALPAGE_RPX,
MRI,
RESMAN
credentialsrequired

JSON encoded credentials for accessing the integration vendor API

namerequired
string

The name of the integration

systemrequired
string

The system the integration is associated with

Available options:
PRODUCTION,
SANDBOX,
DEMO,
STAGING
max_request_cadencerequired
string

Cadence at which to limit the max request frequency

Available options:
MINUTE,
HOUR,
DAY,
WEEK,
MONTH,
SECOND
max_request_frequencyrequired
number

Maximum number of jobs that can be run in the max request cadence

max_job_concurrencyrequired
number

Maximum number of jobs that can be run at once for the integration

active
Default: false
boolean

The active state of the integration

base_url
string | null

DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API

​
Response

resultrequired
object