# Integrations

Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.

OAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications.

## GET /integrations

> Integrations Status

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"IntegrationsResponse":{"properties":{"google":{"$ref":"#/components/schemas/IntegrationStatus"},"gmail":{"$ref":"#/components/schemas/IntegrationStatus"},"whatsapp":{"$ref":"#/components/schemas/IntegrationStatus"},"outlook":{"$ref":"#/components/schemas/IntegrationStatus"}},"type":"object","required":["google","gmail","whatsapp","outlook"],"title":"IntegrationsResponse"},"IntegrationStatus":{"properties":{"connected":{"type":"boolean","title":"Connected"},"default_calendar_id":{"title":"Default Calendar Id","type":"string"}},"type":"object","required":["connected"],"title":"IntegrationStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations":{"get":{"tags":["integrations","integrations"],"summary":"Integrations Status","operationId":"integrations_status_integrations_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /integrations/google/calendars

> List Google Calendars

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"GoogleCalendarListEntry":{"properties":{"id":{"type":"string","title":"Id"},"summary":{"title":"Summary","type":"string"},"accessRole":{"title":"Accessrole","type":"string"},"primary":{"type":"boolean","title":"Primary","default":false}},"type":"object","required":["id"],"title":"GoogleCalendarListEntry"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/calendars":{"get":{"tags":["integrations"],"summary":"List Google Calendars","operationId":"list_google_calendars_integrations_google_calendars_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCalendarListEntry"},"title":"Response List Google Calendars Integrations Google Calendars Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/connect

> Google Connect

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"GoogleConnectRequest":{"properties":{"return_to":{"title":"Return To","description":"Optional URL to return to after OAuth","type":"string","maxLength":2083,"minLength":1,"format":"uri"}},"type":"object","title":"GoogleConnectRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/connect":{"post":{"tags":["integrations","integrations"],"summary":"Google Connect","operationId":"google_connect_integrations_google_connect_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Body","$ref":"#/components/schemas/GoogleConnectRequest"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/default-calendar

> Set Default Google Calendar

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"GoogleDefaultCalendarRequest":{"properties":{"calendar_id":{"type":"string","title":"Calendar Id"}},"type":"object","required":["calendar_id"],"title":"GoogleDefaultCalendarRequest"},"GoogleCalendarListEntry":{"properties":{"id":{"type":"string","title":"Id"},"summary":{"title":"Summary","type":"string"},"accessRole":{"title":"Accessrole","type":"string"},"primary":{"type":"boolean","title":"Primary","default":false}},"type":"object","required":["id"],"title":"GoogleCalendarListEntry"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/default-calendar":{"post":{"tags":["integrations"],"summary":"Set Default Google Calendar","operationId":"set_default_google_calendar_integrations_google_default_calendar_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDefaultCalendarRequest"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCalendarListEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/disconnect

> Google Disconnect

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/disconnect":{"post":{"tags":["integrations","integrations"],"summary":"Google Disconnect","operationId":"google_disconnect_integrations_google_disconnect_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/gmail/connect

> Google Gmail Connect

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"GoogleConnectRequest":{"properties":{"return_to":{"title":"Return To","description":"Optional URL to return to after OAuth","type":"string","maxLength":2083,"minLength":1,"format":"uri"}},"type":"object","title":"GoogleConnectRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/gmail/connect":{"post":{"tags":["integrations","integrations"],"summary":"Google Gmail Connect","operationId":"google_gmail_connect_integrations_google_gmail_connect_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Body","$ref":"#/components/schemas/GoogleConnectRequest"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/gmail/disconnect

> Google Gmail Disconnect

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/gmail/disconnect":{"post":{"tags":["integrations","integrations"],"summary":"Google Gmail Disconnect","operationId":"google_gmail_disconnect_integrations_google_gmail_disconnect_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /integrations/google/sync

> Sync Google Calendar

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"integrations","description":"Inspect integration status and manage OAuth-based services such as Google Calendar and Gmail.\n\nOAuth callback URLs and provider webhooks are intentionally excluded from the public reference because they are called by the external providers, not by client applications."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"GoogleSyncSummary":{"properties":{"created":{"type":"integer","title":"Created","default":0},"updated":{"type":"integer","title":"Updated","default":0},"cancelled":{"type":"integer","title":"Cancelled","default":0},"skipped":{"type":"integer","title":"Skipped","default":0}},"type":"object","title":"GoogleSyncSummary"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/integrations/google/sync":{"post":{"tags":["integrations"],"summary":"Sync Google Calendar","operationId":"sync_google_calendar_integrations_google_sync_post","parameters":[{"name":"full","in":"query","required":false,"schema":{"type":"boolean","description":"Force full resync ignoring stored sync token","default":false,"title":"Full"},"description":"Force full resync ignoring stored sync token"},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleSyncSummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aurorasuite.ai/api-reference/integrations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.