> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a single connector by type > Returns the full configuration and status for a single connector integration by type (e.g. `shopify`, `stripe`, `avatax`). The response includes connection health, sync settings, last-sync timestamp, and any recent error messages. Sensitive credentials (API keys) are never returned. Requires `integrations:read` scope. ## OpenAPI ````yaml /openapi.yaml get /integrations/{connector_type} openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /integrations/{connector_type}: parameters: - name: connector_type in: path required: true description: >- Connector type. Enum: stripe, avatax, shippo, printnode, postmark, shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon, ebay, wwex schema: type: string enum: - stripe - avatax - shippo - printnode - postmark - shopify - mapquest - google - openai - plaid - ups - fedex - usps - amazon - ebay - wwex get: tags: - Integrations summary: Get a single connector by type description: > Returns the full configuration and status for a single connector integration by type (e.g. `shopify`, `stripe`, `avatax`). The response includes connection health, sync settings, last-sync timestamp, and any recent error messages. Sensitive credentials (API keys) are never returned. Requires `integrations:read` scope. operationId: getIntegrationV1 parameters: - name: mode in: query required: false schema: type: string enum: - sandbox - live description: >- If omitted, returns the row matching the entity's current environment. responses: '200': description: >- Connector row (credentials NEVER included; has_credentials_secret_arn indicates if credentials are stored) content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ConnectorRow' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: schemas: ConnectorRow: type: object description: > A configured connector row from entity_connectors. SECURITY: credentials, webhook_secret, and credentials_secret_arn RAW VALUES are NEVER returned. has_credentials_secret_arn (boolean) indicates if credentials are stored. credentials_masked returns key names only (no values). These invariants are enforced by the canonical listConnectors/getConnectorByType handler projection and cannot be overridden by callers. properties: id: type: string format: uuid entity_id: type: string format: uuid connector_type: type: string enum: - stripe - avatax - shippo - printnode - postmark - shopify - mapquest - google - openai - plaid - ups - fedex - usps - amazon - ebay - wwex display_name: type: string mode: type: string enum: - sandbox - live is_active: type: boolean config: type: object description: Provider-specific configuration (opaque JSON) has_webhook_secret: type: boolean description: >- True if a webhook signing secret is configured (value never returned) has_credentials_secret_arn: type: boolean description: >- True if credentials are stored in AWS Secrets Manager (ARN never returned) last_sync_at: type: string format: date-time nullable: true sync_status: type: string nullable: true sync_error: type: string nullable: true ship_from_name: type: string nullable: true ship_from_address1: type: string nullable: true ship_from_city: type: string nullable: true ship_from_state: type: string nullable: true ship_from_zip: type: string nullable: true seller_id: type: string nullable: true bank_account_id: type: string format: uuid nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````