---
updatedAt: 2025-08-27T15:59:41.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/v2.5/llms.txt
---

# Retrieve a single user connection sync

Requires **user:read** scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/users/{userId}/syncs/{syncId}": {
      "get": {
        "summary": "Retrieve a single user connection sync",
        "description": "Requires **user:read** scope.",
        "parameters": [
          {
            "description": "The user Id",
            "in": "path",
            "name": "userId",
            "required": true,
            "example": "6017d86094e693ab5114dee0",
            "schema": {
              "type": "string",
              "minLength": 24,
              "maxLength": 24
            }
          },
          {
            "description": "The sync id",
            "in": "path",
            "name": "syncId",
            "required": true,
            "example": "6d948478-d6ac-4ac2-a192-39d3c0486616",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Syncs Response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/ConnectionSync"
                    },
                    "meta": {
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Unsuccessful Response - Resource Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "user connections"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "ConnectionSync": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of sync",
            "format": "uuid",
            "example": "5f8f299f-8fad-4fe0-a94f-db4316fbc977"
          },
          "connectionId": {
            "type": "string",
            "description": "Connection id composed of the bank id and unique connection id",
            "example": "1ffe704d39629a929c8e293880fb449a:d64751de-1254-4ec5-b3e7-e5b53d88c6b6"
          },
          "action": {
            "type": "string",
            "description": "Action of the sync",
            "example": "auto-update",
            "enum": [
              "auto-update",
              "client-update"
            ]
          },
          "method": {
            "type": "string",
            "description": "Method of the sync",
            "example": "ADD",
            "enum": [
              "ADD",
              "UPDATE"
            ]
          },
          "fetchStatus": {
            "type": "string",
            "description": "Status of the sync",
            "example": "success",
            "enum": [
              "success",
              "error",
              "partial",
              "mfa-required",
              "credentials-error"
            ]
          },
          "createdAt": {
            "type": "string",
            "description": "When the sync started",
            "example": "2021-02-23T15:14:51.015Z",
            "format": "date-time"
          },
          "fetchedAt": {
            "type": "string",
            "description": "When the sync last updated",
            "example": "2021-02-23T15:14:51.015Z",
            "format": "date-time"
          },
          "accounts": {
            "description": "List of accounts that were synced",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "providerId": {
                  "type": "string",
                  "description": "The ID of the account held by the banking provider",
                  "example": "provider-id"
                },
                "accountId": {
                  "type": "string",
                  "format": "uuid",
                  "description": "The ID of the account when stored by Moneyhub"
                },
                "postConnectionEnrichmentStatus": {
                  "type": "string",
                  "enum": [
                    "success",
                    "error"
                  ],
                  "description": "Shows whether the regular transactions for the given account has been synchronised"
                },
                "postConnectionEnrichedAt": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The time at which regular transactions were retrieved at"
                }
              },
              "required": [
                "accountId",
                "providerId"
              ]
            }
          }
        },
        "required": [
          "id",
          "connectionId",
          "action",
          "method",
          "fetchStatus",
          "createdAt",
          "fetchedAt",
          "accounts"
        ]
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```