GET
/
integrations
/
status
/
{externalUserIdentifier}
[
  {
    "type": "google-analytics",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T15:30:00Z",
    "propertyId": "123456789",
    "syncSchedule": "0 */6 * * *"
  },
  {
    "type": "notion",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T15:00:00Z",
    "workspaceName": "My Workspace",
    "syncSchedule": "0 */12 * * *"
  },
  {
    "type": "zoho",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T14:45:00Z",
    "organizationId": "org-123",
    "dc": "com",
    "enabledModules": {
      "crm": true,
      "books": true,
      "projects": true
    },
    "syncSchedule": "0 */4 * * *"
  }
]

Get the current status and configuration of all integrations for a specific user.

URL Parameters

externalUserIdentifier
string
required

Unique identifier for the user in your system

Response

integrations
array

List of integration statuses

{
  type: string
  enabled: boolean
  connected: boolean
  lastSynced: string
  // Additional fields vary by integration type
}[]

Integration-Specific Fields

Google Analytics

propertyId
string

Selected Google Analytics property ID

syncSchedule
string

Data sync schedule

Notion

workspaceName
string

Connected Notion workspace name

syncSchedule
string

Data sync schedule

Slack

teamId
string

Connected Slack team ID

syncSchedule
string

Data sync schedule

Zoho

organizationId
string

Connected Zoho organization ID

dc
string

Zoho data center

enabledModules
object

Enabled Zoho modules

{
  crm: boolean
  books: boolean
  projects: boolean
}
syncSchedule
string

Data sync schedule

Example

curl https://suada.ai/api/public/integrations/status/user-123 \
  -H "Authorization: Bearer sk-suada-your-api-key"
[
  {
    "type": "google-analytics",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T15:30:00Z",
    "propertyId": "123456789",
    "syncSchedule": "0 */6 * * *"
  },
  {
    "type": "notion",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T15:00:00Z",
    "workspaceName": "My Workspace",
    "syncSchedule": "0 */12 * * *"
  },
  {
    "type": "zoho",
    "enabled": true,
    "connected": true,
    "lastSynced": "2024-02-20T14:45:00Z",
    "organizationId": "org-123",
    "dc": "com",
    "enabledModules": {
      "crm": true,
      "books": true,
      "projects": true
    },
    "syncSchedule": "0 */4 * * *"
  }
]

Error Codes

401
object

Authentication error

{
  "error": "Invalid or expired API key"
}
404
object

User not found

{
  "error": "User not found"
}
500
object

Server error

{
  "error": "Failed to get integration status"
}

Notes

  • The response includes all available integrations, whether connected or not
  • The lastSynced timestamp indicates when data was last synchronized
  • The syncSchedule is in cron format
  • Each integration type may have additional fields specific to its configuration
  • The enabled field indicates whether the integration is currently active
  • The connected field indicates whether the OAuth connection is valid