> ## Documentation Index > Fetch the complete documentation index at: https://supermemory.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get connector > Read one connector. Add include=syncs to include its recent sync runs and the items that failed. include=picker needs an admin with write access, since the link changes what syncs. ## OpenAPI ````yaml https://api.supermemory.ai/v5/openapi get /ns/{namespace}/connectors/{id} openapi: 3.1.0 info: title: supermemory API description: >- The Memory API for the AI era. OpenAPI operations include x-codeSamples for the official TypeScript and Python SDKs (Mintlify-compatible). version: 5.0.0 servers: - description: Production Server url: https://api.supermemory.ai security: - bearerAuth: [] tags: - name: Ingest description: Ingest documents, files, URLs, conversations, and other content - name: Recall (Search) description: >- Semantic recall across your content — supports memories, hybrid, and documents modes - name: Profiles description: Maintained static, dynamic, and custom-bucket profiles scoped by namespace - name: Content Management description: List, get, update, and delete content and memories - name: Namespaces description: List and manage isolated namespaces and their settings - name: Connectors description: >- Sync external sources such as Google Drive, Notion and GitHub into a namespace - name: Organization description: Read and update organization-wide settings paths: /ns/{namespace}/connectors/{id}: get: tags: - Connectors summary: Get connector description: >- Read one connector. Add include=syncs to include its recent sync runs and the items that failed. include=picker needs an admin with write access, since the link changes what syncs. operationId: getNsByNamespaceConnectorsById parameters: - in: path name: namespace schema: type: string maxLength: 100 pattern: ^[a-zA-Z0-9_:-]+$ example: user_alex required: true description: >- Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories. - in: path name: id schema: type: string minLength: 1 example: PTzGiUYei7pgzg5buzZHgA required: true description: Connector identifier returned when the connector was created - in: query name: include schema: type: array items: type: string enum: - syncs - picker style: form explode: false description: >- Comma-separated extras. syncs: the 10 most recent sync runs with their failed items. picker: a one-time hosted picker URL. - in: query name: returnUrl schema: type: string format: uri description: Where the hosted picker sends the user when they finish responses: '200': content: application/json: schema: type: object properties: id: type: string provider: type: string enum: - notion - google-drive - onedrive - gmail - github - web-crawler - s3 - granola description: External source authorization: description: >- Present while pending, when the caller can create connectors in this namespace type: object properties: url: type: string description: Send the user here to authorize the provider expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: When url stops working required: - url - expiresAt namespace: anyOf: - type: string - type: 'null' description: >- Namespace the connector syncs into. Null only for connectors created before namespaces were required. account: anyOf: - type: string - type: 'null' description: Account on the provider side, usually an email capabilities: type: object properties: selectable: type: boolean description: Supports choosing what to sync via the hosted picker webhooks: type: boolean description: Receives change notifications instead of only polling required: - selectable - webhooks config: anyOf: - type: object propertyNames: type: string additionalProperties: anyOf: - type: string - type: number - type: boolean - type: 'null' description: >- Non-secret setup, such as the S3 bucket, crawler start URL or Notion workspace. Credentials are never returned. selection: anyOf: - type: object propertyNames: type: string additionalProperties: type: array items: type: object properties: id: type: string name: type: string required: - id - name - type: 'null' description: >- What syncs, grouped by kind (repos, labels, files or folders), each a list of { id, name }. Null for connectors that sync everything. example: labels: - id: INBOX name: Inbox documentLimit: type: number documentCount: type: number latestRun: anyOf: - type: object properties: errorCode: anyOf: - type: string enum: - auth_expired - rate_limited - plan_required - provider_unavailable - internal - type: 'null' error: anyOf: - type: string - type: 'null' description: Customer-safe error message system: type: object properties: status: type: string enum: - running - completed - failed startedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp when the run started completedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' description: >- ISO 8601 timestamp when the run ended; null while running required: - status - startedAt - completedAt description: >- Run status and timestamps maintained by Supermemory required: - errorCode - error - system - type: 'null' description: >- The most recent sync run, which may still be running or may have failed system: type: object properties: status: type: string enum: - pending_authorization - active description: >- pending_authorization until the user finishes the provider login at authorization.url; DELETE cancels it. Pending connectors are not listed. createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp when the connector was created lastSuccessfulSyncAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' description: >- ISO 8601 timestamp when content last finished syncing successfully required: - status - createdAt - lastSuccessfulSyncAt description: Lifecycle status and timestamps maintained by Supermemory syncs: description: Present when include=syncs type: array items: type: object properties: errorCode: anyOf: - type: string enum: - auth_expired - rate_limited - plan_required - provider_unavailable - internal - type: 'null' error: anyOf: - type: string - type: 'null' description: Customer-safe error message system: type: object properties: status: type: string enum: - running - completed - failed startedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp when the run started completedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' description: >- ISO 8601 timestamp when the run ended; null while running required: - status - startedAt - completedAt description: Run status and timestamps maintained by Supermemory id: type: string trigger: type: string enum: - event - cron - manual itemsProcessed: type: number itemsFailed: type: number failures: type: array items: type: object properties: documentId: type: string title: anyOf: - type: string - type: 'null' errorCode: type: string errorMessage: type: string failedAt: type: string required: - documentId - title - errorCode - errorMessage - failedAt description: Failed items, capped. itemsFailed is the true count. required: - errorCode - error - system - id - trigger - itemsProcessed - itemsFailed - failures picker: description: >- Present when include=picker. Null for connectors that sync everything. anyOf: - type: object properties: url: type: string description: >- Send the user here to choose what syncs. Works once, in any browser. expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - url - expiresAt - type: 'null' required: - id - provider - namespace - account - capabilities - config - selection - documentLimit - documentCount - latestRun - system description: Connector '400': description: Invalid request content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/ValidationErrorResponse' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Namespace access denied '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Connector not found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Internal server error x-codeSamples: - lang: typescript label: TypeScript SDK source: >- import { Supermemory } from "supermemory"; const client = new Supermemory(); // reads SUPERMEMORY_API_KEY const connector = await client.connectors.get("user_123", "conn_abc123", { include: ["syncs", "picker"], }); console.log(connector.latestRun?.system.status, connector.syncs?.length, connector.picker?.url); - lang: python label: Python SDK source: >- from supermemory import Supermemory client = Supermemory() # reads SUPERMEMORY_API_KEY connector = client.connectors.get("user_123", "conn_abc123", include=["syncs", "picker"]) print(connector.latest_run, connector.syncs, connector.picker) - lang: bash label: cURL source: >- curl "https://api.supermemory.ai/ns/user_123/connectors/conn_abc123?include=syncs,picker" \ -H "Authorization: Bearer $SUPERMEMORY_API_KEY" components: schemas: ErrorResponse: type: object properties: error: type: string description: Error message example: Invalid request parameters details: type: string description: Additional error details example: Query must be at least 1 character long required: - error ValidationErrorResponse: type: object description: Body returned when request input fails schema validation properties: success: type: boolean enum: - false error: type: array description: Validation issues items: type: object properties: message: type: string path: type: array items: oneOf: - type: string - type: number required: - message data: description: The input that failed validation required: - success - error securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.