> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a connector profile > Returns the connector profile including its saved setup fields, redacted secrets and action/event/sync configuration, everything needed to pre-fill an edit form. ## OpenAPI ````yaml get /v2/connector_profiles/{id} openapi: 3.1.0 info: title: StackOne description: The documentation for the StackOne API version: 1.0.0 contact: {} servers: - url: https://api.stackone.com security: [] tags: - name: Accounts description: View and manage linked accounts. - name: Connector Profiles description: View and manage connector profiles for the project. - name: Connectors description: Retrieve metadata for connectors. - name: Webhooks description: Configure and manage webhooks. - name: Data Sync description: View data-sync configs, schedules, and runs. paths: /v2/connector_profiles/{id}: get: tags: - Connector Profiles summary: Get a connector profile description: >- Returns the connector profile including its saved setup fields, redacted secrets and action/event/sync configuration, everything needed to pre-fill an edit form. operationId: get_connector_profile parameters: - name: id required: true in: path description: The unique identifier of the connector profile. schema: type: string - name: expand required: false in: query description: >- A comma-separated list of additional fields to expand. Supported values: `connector` (the connector this profile configures), `version` (the connector version this profile resolves to), `accounts_count` (the number of accounts linked to this profile) and `enabled_actions_count` (how many of that version's actions this profile enables). These are returned as `null` unless requested. schema: nullable: true example: connector,version type: string responses: '200': description: The connector profile was retrieved. content: application/json: schema: $ref: '#/components/schemas/ConnectorProfileDetailResource' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Unauthorized access. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '408': description: The request has timed out. headers: Retry-After: description: A time in seconds after which the request can be retried. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RequestTimedOutResponse' '409': description: Conflict with current state. content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' '422': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' '429': description: Too many requests. content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsResponse' '500': description: Server error while executing the request. content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' '501': description: This functionality is not implemented. content: application/json: schema: $ref: '#/components/schemas/NotImplementedResponse' '502': description: Bad gateway error. content: application/json: schema: $ref: '#/components/schemas/BadGatewayResponse' security: - basic: [] components: schemas: ConnectorProfileDetailResource: type: object properties: id: type: string description: The unique identifier of the connector profile. name: type: string description: The display name of the connector profile. connector_key: type: string description: >- The connector key (e.g. `workday`). Always present; the full connector object requires `?expand=connector`. connector: nullable: true description: >- The connector this profile configures. Always present; `null` unless requested via `?expand=connector`. allOf: - $ref: '#/components/schemas/ProfileConnectorResource' version: nullable: true description: >- The connector version this profile resolves to. Always present; `null` unless requested via `?expand=version`. allOf: - $ref: '#/components/schemas/ProfileVersionResource' accounts_count: type: integer nullable: true description: >- The number of accounts linked to this connector profile that are visible to you. Always present; `null` unless requested via `?expand=accounts_count`. enabled_actions_count: type: integer nullable: true description: >- How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. `0` when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; `null` unless requested via `?expand=enabled_actions_count` on a read endpoint, and always `null` on create. active: type: boolean description: Whether the connector profile is active. default: type: boolean description: Whether this is the default connector profile. environment: type: string nullable: true description: The environment of the connector profile. authentication_config_key: type: string nullable: true description: The authentication configuration key. created_at: type: string description: The timestamp when the connector profile was created. format: date-time updated_at: type: string description: The timestamp when the connector profile was last updated. format: date-time setup_fields: type: object additionalProperties: true description: The saved non-secret setup field values, keyed by setup field key. secrets: type: object additionalProperties: type: string nullable: true description: >- The saved secret fields, keyed by field key. Values are `__secretvalue:`-prefixed redacted placeholders (never the plaintext); resend a placeholder unchanged to keep the stored secret. action_config: type: object additionalProperties: type: object properties: enabled: type: boolean required: - enabled description: The per-action enablement of the profile, keyed by action id. event_config: type: object additionalProperties: type: object properties: enabled: type: boolean webhook_ids: type: array items: type: string required: - enabled - webhook_ids description: >- The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id. sync_config: type: object additionalProperties: type: object properties: enabled: type: boolean cadence: type: string start_at: type: string full_sync_after: type: string auto_link: type: boolean description: >- Whether the action syncs automatically on every account linked to this profile. Turning it on creates a schedule for the accounts already linked as well as any linked later; turning it off pauses those schedules rather than deleting them. Hand-authored schedules are unaffected. Omit to leave the stored value unchanged. required: - enabled - cadence - full_sync_after description: The per-action data-sync configuration, keyed by action id. required: - id - name - connector_key - connector - version - accounts_count - enabled_actions_count - active - default - environment - authentication_config_key - created_at - updated_at - setup_fields - secrets - action_config - event_config - sync_config BadRequestResponse: type: object properties: statusCode: type: number description: HTTP status code example: 400 message: type: string description: Error message example: Bad Request timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time data: description: Error details nullable: true allOf: - $ref: '#/components/schemas/UnifiedError' provider_errors: description: List of provider-specific errors nullable: true type: array items: $ref: '#/components/schemas/ProviderError' required: - statusCode - message - timestamp UnauthorizedResponse: type: object properties: statusCode: type: number description: HTTP status code example: 401 message: type: string description: Error message example: Unauthorized timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ForbiddenResponse: type: object properties: statusCode: type: number description: HTTP status code example: 403 message: type: string description: Error message example: Forbidden resource timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp NotFoundResponse: type: object properties: statusCode: type: number description: HTTP status code example: 404 message: type: string description: Error message example: Not Found timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp RequestTimedOutResponse: type: object properties: statusCode: type: number description: HTTP status code example: 408 message: type: string description: Error message example: Request timed out timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ConflictResponse: type: object properties: statusCode: type: number description: HTTP status code example: 409 message: type: string description: Error message example: Conflict timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp UnprocessableEntityResponse: type: object properties: statusCode: type: number description: HTTP status code example: 422 message: type: string description: Error message example: Unprocessable Entity timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp TooManyRequestsResponse: type: object properties: statusCode: type: number description: HTTP status code example: 429 message: type: string description: Error message example: Too many requests timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp InternalServerErrorResponse: type: object properties: statusCode: type: number description: HTTP status code example: 500 message: type: string description: Error message example: Internal server error timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp NotImplementedResponse: type: object properties: statusCode: type: number description: HTTP status code example: 501 message: type: string description: Error message example: Not Implemented timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp BadGatewayResponse: type: object properties: statusCode: type: number description: HTTP status code example: 502 message: type: string description: Error message example: Bad Gateway timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ProfileConnectorResource: type: object properties: key: type: string description: The connector key (e.g. `workday`). name: type: string description: The human-readable connector name (e.g. `Workday`). logo_url: type: string description: The URL of the connector's logo. categories: description: The categories the connector belongs to (e.g. `["hris"]`). type: array items: type: string release_stage: type: string description: The release stage of the connector (e.g. `ga`, `beta`). authentication_config_label: type: string nullable: true description: >- The human-readable label of the profile's authentication configuration; `null` when the profile has no authentication configuration key. required: - key - name - logo_url - categories - release_stage - authentication_config_label ProfileVersionResource: type: object properties: resolved: type: string nullable: true description: The connector version the profile currently resolves to. pinned: type: string nullable: true description: >- The explicitly pinned connector version; `null` when no version is pinned. owner: type: string nullable: true description: The owner of the resolved connector version. required: - resolved - pinned - owner UnifiedError: type: object properties: statusCode: type: number description: HTTP status code example: 400 nullable: true message: type: string description: Error message example: Bad Request nullable: true headers: type: object description: Response headers example: content-type: application/json x-request-id: 5678c28b211dace4e0a0f9171e6b88c5 nullable: true ProviderError: type: object properties: status: type: number description: HTTP status code of the provider error example: 400 nullable: true url: type: string description: URL that caused the error example: https://api.provider.com/v1/resource nullable: true raw: type: object description: Raw error response from the provider example: message: Invalid input parameters nullable: true headers: type: object description: Response headers example: content-type: application/json x-request-id: 5678c28b211dace4e0a0f9171e6b88c5 nullable: true securitySchemes: basic: type: http scheme: basic ````