Skip to content
FloralityDocs
ChangelogGet an API key

Getting started

  • Quickstart
  • Authentication
  • Scopes
  • Privacy buckets
  • Rate limits
  • Errors
  • Versioning
  • Terminology
  • Webhooks PRO

Resources

  • Members
  • Groups
  • Entries
  • Front
  • Appearance
  • Custom fields
  • Trash
  • Search
  • Member statuses
  • Systems
  • Messaging
  • Privacy buckets
  • Terminology
  • Friends
  • Subscriptions
  • Billing
  • Import
  • Social
  • Guestbook & poll
  • Group layout
  • Activity
Docs/Resources/get import runs
Florality

Organise your system. One front at a time.

Get started

Product

  • Features
  • Pricing
  • Docs
  • Changelog
  • Security

Company

  • About
  • Our team
  • Blog
  • Contact

Resources

  • FAQ
  • Trust and Safety
  • Public REST API

Legal

  • Privacy Policy
  • Terms of Service
  • Refunds and cancellation

© 2026 Florality. All rights reserved.

Florality
ImportList import runs

List import runs

Returns import runs accessible to the API key’s account.

GET
/api/v1/import/runs
import: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

Query parameters

NameTypeRequiredDescription
limitintegerOptionalFilter or option: limit. Minimum: 1. Maximum: 100.

Response schema

200

Successful response.

NameTypeRequiredDescription
_idstringRequiredUnique identifier.
userIdstringRequiredOwning account identifier.
statusstringRequiredStatus.
startedAtnumberRequiredStarted At.
finishedAtnumberOptionalFinished At.
summaryobjectRequiredSummary.
summary.directoriesobjectRequiredDirectories.
summary.directories.creatednumberRequiredCreated.
summary.directories.skippednumberRequiredSkipped.
summary.directories.failednumberRequiredFailed.
summary.directories.updatednumberOptionalUpdated.
summary.membersobjectRequiredMembers.
summary.members.creatednumberRequiredCreated.
summary.members.skippednumberRequiredSkipped.
summary.members.failednumberRequiredFailed.
summary.members.updatednumberOptionalUpdated.
summary.members.archivednumberOptionalArchived.
summary.entriesobjectRequiredEntries.
summary.entries.creatednumberRequiredCreated.
summary.entries.skippednumberRequiredSkipped.
summary.entries.failednumberRequiredFailed.
summary.entries.updatednumberOptionalUpdated.
summary.frontSessionsobjectRequiredFront Sessions.
summary.frontSessions.creatednumberRequiredCreated.
summary.frontSessions.skippednumberRequiredSkipped.
summary.frontSessions.failednumberRequiredFailed.
summary.frontSessions.updatednumberOptionalUpdated.
summary.memberStatusesobjectOptionalMember Statuses.
summary.memberStatuses.creatednumberRequiredCreated.
summary.memberStatuses.skippednumberRequiredSkipped.
summary.memberStatuses.failednumberRequiredFailed.
summary.memberStatuses.updatednumberOptionalUpdated.
summary.memberStatuses.avatarsImportednumberOptionalAvatars Imported.
summary.memberStatuses.avatarsFailednumberOptionalAvatars Failed.
summary.memberStatuses.failureReasonsobjectOptionalFailure Reasons.
summary.mediaobjectOptionalMedia.
summary.media.avatarsobjectOptionalAvatars.
summary.media.backgroundsobjectOptionalBackgrounds.
summary.media.skippedReasonstringOptionalSkipped Reason. Set when MinIO probe fails — import continues without re-hosting images.
summary.simplyPluralAvatarFailuresarray<object>OptionalSimply Plural Avatar Failures.
summary.simplyPluralAvatarFailures[].sourceMemberIdstringRequiredSource Member Id.
summary.simplyPluralAvatarFailures[].namestringRequiredName of the resource.
summary.simplyPluralAvatarFailures[].reasonstringOptionalReason.
errorMessagestringOptionalError Message.
progressPhasestringOptionalProgress Phase.
progressPercentnumberOptionalProgress Percent.
progressDetailstringOptionalProgress Detail.
targetSideSystemIdnull | stringOptionalTarget Side System Id.
targetSubSystemIdnull | stringOptionalTarget Sub System Id.

Errors

400 · JSON error

Request failed (BAD_REQUEST).

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires import: read; ownership or feature restrictions may also deny access.

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

503 · JSON error

PostgreSQL is not configured (DATABASE_URL).

← Previous endpointUpdate import runNext endpoint →Start import

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell
curl --request GET 'https://floralitys.com/api/v1/import/runs' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON
[
  {
    "_id": "11111111-1111-4111-8111-111111111111",
    "userId": "11111111-1111-4111-8111-111111111111",
    "status": "demo",
    "startedAt": 1767225600000,
    "finishedAt": 1767225600000,
    "summary": {
      "directories": {
        "created": 0,
        "skipped": 0,
        "failed": 0,
        "updated": 0
      },
      "members": {
        "created": 0,
        "skipped": 0,
        "failed": 0,
        "updated": 0,
        "archived": 0
      },
      "entries": {
        "created": 0,
        "skipped": 0,
        "failed": 0,
        "updated": 0
      },
      "frontSessions": {
        "created": 0,
        "skipped": 0,
        "failed": 0,
        "updated": 0
      },
      "memberStatuses": {
        "created": 0,
        "skipped": 0,
        "failed": 0,
        "updated": 0,
        "avatarsImported": 0,
        "avatarsFailed": 0,
        "failureReasons": {}
      },
      "media": {
        "avatars": {
          "attempted": 0,
          "succeeded": 0,
          "failed": 0
        },
        "backgrounds": {
          "attempted": 0,
          "succeeded": 0,
          "failed": 0
        },
        "skippedReason": "demo"
      },
      "simplyPluralAvatarFailures": [
        {
          "sourceMemberId": "11111111-1111-4111-8111-111111111111",
          "name": "River",
          "reason": "demo"
        }
      ]
    },
    "errorMessage": "demo",
    "progressPhase": "demo",
    "progressPercent": 0,
    "progressDetail": "demo",
    "targetSideSystemId": null,
    "targetSubSystemId": null
  }
]

Example values are illustrative demo data.