Identity: export

This identity’s contacts, threads, messages and files as one unencrypted zip (design §4), streamed and never stored

GET /v1/identities/{slug}/export · operation exportIdentity

Requires the batondeck:workspace:admin permission (action identity:export).

Requires a step-up: MFA enrolled and re-authenticated within 15 minutes. Not reachable with an API key — a key has no session and so can never step up.

Parameters

Name	In	Type	Required	Notes
slug	path	string	yes
acknowledge	query	string		Must be “unencrypted”: This file is not encrypted. Anyone who gets it can read your contact list and all your conversations and files. It holds no keys, so it cannot be used to speak as you. Keep it where you keep private documents, and delete it once it has been imported.

Responses

Status	Meaning
200	This identity’s contacts, threads, messages and files as one unencrypted zip (design §4), streamed and never stored
400	The arguments did not validate.
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

curl -X GET 'https://api.batondeck.com/v1/identities/:slug/export' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"

What this identity’s export would say of itself, without the file: each import ceiling it passes, and every message it leaves out, by id and why

GET /v1/identities/{slug}/export/report · operation getExportReport

Requires the batondeck:identities:read permission (action identity:read).

Parameters

Name	In	Type	Required	Notes
slug	path	string	yes

Responses

Status	Meaning
200	What this identity’s export would say of itself, without the file: each import ceiling it passes, and every message it leaves out, by id and why
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

200 response schema

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "left_out": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "reason"
        ],
        "additionalProperties": false
      }
    },
    "bytes": {
      "type": "number"
    }
  },
  "required": [
    "warnings",
    "left_out",
    "bytes"
  ],
  "additionalProperties": false
}

curl -X GET 'https://api.batondeck.com/v1/identities/:slug/export/report' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"