pointeron
  • Docs
  • API
  • Store
  • Home
  • Docs
  • Store
  • Home
  • Guides

    • Introduction
    • Quickstart
    • SDKs
    • Authentication
    • Pagination
    • Errors
    • Webhooks
  • Resources

    • Organizations
    • Assets
    • Devices
    • Locations
    • Geofences
    • Alerts
    • Webhooks
    • API Keys
    • Data Exports
      • The data export model
      • Create an export requestPOST
      • List all exportsGET
      • Retrieve an exportGET
      • Download an exportGET
  • Sign in
PreviousAPI Keys

Data Exports

Request and download full exports of your organization's data. Data exports allow you to retrieve a complete snapshot of your organization's information in a structured JSON format for portability, compliance, or backup purposes.

Export includes: organization settings, users, assets, devices, geofences, categories, alert rules, webhooks, API keys (identifiers only), location history (up to 100,000 points), and activity logs. Sensitive data (passwords, secrets, credentials) is never included. Downloads expire after 7 days.

The data export model

The data export model contains all the information about an export request, including its current status, file metadata, and timestamps.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the data export.

  • Name
    organization_id
    Type
    string
    Description

    Unique identifier for the organization the export belongs to.

  • Name
    requested_by
    Type
    number
    Description

    The ID of the user who requested the export.

  • Name
    status
    Type
    string
    Description

    The current status of the export. One of pending, processing, completed, failed, or expired.

  • Name
    format
    Type
    string
    Description

    The format of the export file. Currently only json.

  • Name
    file_size_bytes
    Type
    number
    Description

    The size of the export file in bytes. Null until the export is completed.

  • Name
    checksum_sha256
    Type
    string
    Description

    The SHA-256 checksum of the export file for integrity verification. Null until the export is completed.

  • Name
    error_message
    Type
    string
    Description

    A description of the error if the export failed. Null unless status is failed.

  • Name
    started_at
    Type
    timestamp
    Description

    Timestamp of when processing began. Null while status is pending.

  • Name
    completed_at
    Type
    timestamp
    Description

    Timestamp of when the export finished processing. Null until completed or failed.

  • Name
    expires_at
    Type
    timestamp
    Description

    Timestamp of when the export file will expire and no longer be available for download.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the export was requested.


POST/v2/data-exports

Create an export request

This endpoint allows you to request a new data export for your organization. No request body is required — the export will include all available data for the organization. The export is processed asynchronously; poll the status endpoint to check progress.

Only one export can be in pending or processing status at a time. If you attempt to create a new export while one is already in progress, the API will return a 409 Conflict error.

Request

POST
/v2/data-exports
curl -X POST https://api.pointeron.com/v2/data-exports \
  -H "Authorization: Bearer {token}"

Response (202)

{
  "data": {
    "id": 1,
    "organization_id": 5,
    "requested_by": 42,
    "status": "pending",
    "format": "json",
    "file_size_bytes": null,
    "checksum_sha256": null,
    "error_message": null,
    "started_at": null,
    "completed_at": null,
    "expires_at": null,
    "created_at": "2026-03-14T10:00:00+00:00"
  }
}

GET/v2/data-exports

List all exports

This endpoint allows you to retrieve a paginated list of all data exports for your organization.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of exports returned. Default: 20, max: 100.

  • Name
    cursor
    Type
    string
    Description

    Cursor for pagination.

Request

GET
/v2/data-exports
curl -G https://api.pointeron.com/v2/data-exports \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "data": [
    {
      "id": 1,
      "status": "completed",
      "format": "json",
      "file_size_bytes": 2458901,
      "checksum_sha256": "a3f2b8c1d4e5f6...",
      "expires_at": "2026-03-21T10:02:00+00:00",
      "created_at": "2026-03-14T10:00:00+00:00"
    }
  ],
  "meta": {
    "has_more": false,
    "next_cursor": null
  }
}

GET/v2/data-exports/:id

Retrieve an export

This endpoint allows you to retrieve a single data export by its ID. Use this to poll the status of an in-progress export.

Request

GET
/v2/data-exports/1
curl https://api.pointeron.com/v2/data-exports/1 \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "id": 1,
    "organization_id": 5,
    "requested_by": 42,
    "status": "completed",
    "format": "json",
    "file_size_bytes": 2458901,
    "checksum_sha256": "a3f2b8c1d4e5f6...",
    "error_message": null,
    "started_at": "2026-03-14T10:00:30+00:00",
    "completed_at": "2026-03-14T10:02:00+00:00",
    "expires_at": "2026-03-21T10:02:00+00:00",
    "created_at": "2026-03-14T10:00:00+00:00"
  }
}

GET/v2/data-exports/:id/download

Download an export

This endpoint streams the completed export file. Only available when status is completed and the export has not expired. The response includes a X-Checksum-SHA256 header for integrity verification.

Request

GET
/v2/data-exports/1/download
curl https://api.pointeron.com/v2/data-exports/1/download \
  -H "Authorization: Bearer {token}" \
  -o export.json

Was this page helpful?