Integrations

Get a single integration

Get a single integration by id

Required scopes: flex.settings.integrations.read

get/api/v2/organizations/{orgSlug}/integrations/{integrationId}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/integrations/{integrationId}
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.settings.integrations.read

Path parameters

integrationIdstring required

integration id

orgSlugstring required

organization slug

Response

_idstring

The _id of the integration.

typestring

The type of the integration.

userstring

The id of the user that created the integration.

locationsstring[]

The locations the integration is enabled for.

Example response

{
  "_id": "6ae88421c1df3a98369079ba",
  "type": "Custom Integration",
  "user": "6ae88421c1df3a98369079bb",
  "settings": {
    "appClientId": "CMyEmnbBa4I4iTAy",
    "secret": "ISUWAVbiyoIaVUyLhr2Fs7byzaqhh1P9",
    "isExternal": true
  },
  "locations": [
    "6ae88421c1df3a98369079bc",
    "6ae88421c1df3a98369079bd"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.