io.atcr.hold.exportUserData Documentation (EN)

main query

Export all user data from this hold (GDPR compliance). Returns all records stored on this hold's PDS that reference the authenticated user's DID.

Output

Encodingapplication/json

blueskyPosts array Required

Bluesky posts that mention the user

crewRecord ref#crewExport Optional

User's crew record (if they are a crew member)

exportedAt stringdatetime Required

RFC3339 timestamp of when the export was generated

holdDid stringdid Required

DID of this hold service

isCaptain boolean Required

Whether the user is the captain (owner) of this hold

layerRecords array Required

Layer records uploaded by the user

statsRecords array Required

Repository stats records owned by the user

userDid stringdid Required

DID of the user whose data was exported

Errors

AuthRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "exportedAt",
        "holdDid",
        "userDid",
        "isCaptain",
        "layerRecords",
        "statsRecords",
        "blueskyPosts"
      ],
      "properties": {
        "holdDid": {
          "type": "string",
          "format": "did",
          "description": "DID of this hold service"
        },
        "userDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the user whose data was exported"
        },
        "isCaptain": {
          "type": "boolean",
          "description": "Whether the user is the captain (owner) of this hold"
        },
        "crewRecord": {
          "ref": "#crewExport",
          "type": "ref",
          "description": "User's crew record (if they are a crew member)"
        },
        "exportedAt": {
          "type": "string",
          "format": "datetime",
          "description": "RFC3339 timestamp of when the export was generated"
        },
        "blueskyPosts": {
          "type": "array",
          "items": {
            "ref": "#postExport",
            "type": "ref"
          },
          "description": "Bluesky posts that mention the user"
        },
        "layerRecords": {
          "type": "array",
          "items": {
            "ref": "#layerExport",
            "type": "ref"
          },
          "description": "Layer records uploaded by the user"
        },
        "statsRecords": {
          "type": "array",
          "items": {
            "ref": "#statsExport",
            "type": "ref"
          },
          "description": "Repository stats records owned by the user"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {}
  },
  "description": "Export all user data from this hold (GDPR compliance). Returns all records stored on this hold's PDS that reference the authenticated user's DID."
}

crewExport object

No description available.

Properties

addedAt string datetime Optional

An RFC 3339 formatted timestamp.

permissions array of string Optional

No description available.

role string Optional

No description available.

maxLength: 32 bytes

tier string Optional

No description available.

maxLength: 32 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "maxLength": 32
    },
    "tier": {
      "type": "string",
      "maxLength": 32
    },
    "addedAt": {
      "type": "string",
      "format": "datetime"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    }
  }
}

layerExport object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

digest string Optional

No description available.

maxLength: 128 bytes

manifest string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

mediaType string Optional

No description available.

maxLength: 256 bytes

size integer Optional

No description available.

View raw schema

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer"
    },
    "digest": {
      "type": "string",
      "maxLength": 128
    },
    "manifest": {
      "type": "string",
      "format": "at-uri"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "mediaType": {
      "type": "string",
      "maxLength": 256
    }
  }
}

postExport object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

text string Optional

No description available.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes

uri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string",
      "maxLength": 30000,
      "maxGraphemes": 3000
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

statsExport object

No description available.

Properties

lastPull string datetime Optional

An RFC 3339 formatted timestamp.

lastPush string datetime Optional

An RFC 3339 formatted timestamp.

pullCount integer Optional

No description available.

pushCount integer Optional

No description available.

repository string Optional

No description available.

maxLength: 256 bytes

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "type": "object",
  "properties": {
    "lastPull": {
      "type": "string",
      "format": "datetime"
    },
    "lastPush": {
      "type": "string",
      "format": "datetime"
    },
    "pullCount": {
      "type": "integer"
    },
    "pushCount": {
      "type": "integer"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "repository": {
      "type": "string",
      "maxLength": 256
    }
  }
}