Export members

curl "https://app.nautilus.co/api/v1/members?status=active&signupStart=2026-01-01&signupEnd=2026-01-31&limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?limit=1000&offset=1000" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?status=churned&signupStart=2025-10-01" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "organizationId": "<string>",
  "filters": {
    "signupStart": "2023-11-07T05:31:56Z",
    "signupEnd": "2023-11-07T05:31:56Z"
  },
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true,
    "nextOffset": 123
  },
  "members": [
    {
      "membershipId": "<string>",
      "customerId": "<string>",
      "signupDate": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "cancelDate": "2023-11-07T05:31:56Z",
      "tenureDays": 123,
      "planName": "<string>",
      "billingAmount": 123,
      "billingSiteCode": "<string>",
      "billingSiteName": "<string>",
      "creationSiteCode": "<string>",
      "creationSiteName": "<string>",
      "isOnTrial": true,
      "trialAmount": 123,
      "tags": "<unknown>"
    }
  ]
}

{
  "error": "Member export is not available for this organization"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

api

members

curl "https://app.nautilus.co/api/v1/members?status=active&signupStart=2026-01-01&signupEnd=2026-01-31&limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?limit=1000&offset=1000" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?status=churned&signupStart=2025-10-01" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "organizationId": "<string>",
  "filters": {
    "signupStart": "2023-11-07T05:31:56Z",
    "signupEnd": "2023-11-07T05:31:56Z"
  },
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true,
    "nextOffset": 123
  },
  "members": [
    {
      "membershipId": "<string>",
      "customerId": "<string>",
      "signupDate": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "cancelDate": "2023-11-07T05:31:56Z",
      "tenureDays": 123,
      "planName": "<string>",
      "billingAmount": 123,
      "billingSiteCode": "<string>",
      "billingSiteName": "<string>",
      "creationSiteCode": "<string>",
      "creationSiteName": "<string>",
      "isOnTrial": true,
      "trialAmount": 123,
      "tags": "<unknown>"
    }
  ]
}

{
  "error": "Member export is not available for this organization"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Exports membership rows for signup-date and churn analysis.

This endpoint requires a tenant-scoped API key and is available only for eligible organizations.

curl "https://app.nautilus.co/api/v1/members?status=active&signupStart=2026-01-01&signupEnd=2026-01-31&limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?limit=1000&offset=1000" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.nautilus.co/api/v1/members?status=churned&signupStart=2025-10-01" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

The response includes the applied filters, offset pagination, and one row per membership.

{
  "organizationId": "org_example_123",
  "filters": {
    "status": "active",
    "signupStart": "2026-01-01T00:00:00.000Z",
    "signupEnd": "2026-01-31T23:59:59.999Z"
  },
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 842,
    "hasMore": true,
    "nextOffset": 100
  },
  "members": [
    {
      "membershipId": "membership_example_001",
      "customerId": "customer_example_001",
      "signupDate": "2026-01-03T15:22:10.000Z",
      "status": "Active",
      "churnType": "active",
      "cancelDate": null,
      "tenureDays": 181.4,
      "planName": "Unlimited Plus",
      "billingAmount": 39.99,
      "billingSiteCode": "101",
      "billingSiteName": "North Site",
      "creationSiteCode": "101",
      "creationSiteName": "North Site",
      "isOnTrial": false,
      "trialAmount": 0,
      "tags": []
    }
  ]
}

Fields

members[].signupDate is the authoritative recurring-account signup timestamp when available. members[].churnType is active, voluntary, or involuntary. A Cancelled status is voluntary. Other terminal statuses are involuntary. members[].billingSiteCode and members[].billingSiteName describe the current billing site when Nautilus can resolve it. members[].tags contains raw POS tag JSON, usually vehicle or RFID tag records. It is not normalized campaign attribution.

Dates and pagination

signupStart and signupEnd accept date-only values or explicit timestamps. Date-only lower bounds start at 00:00:00.000Z; date-only upper bounds include the full UTC day. Rows are ordered by signupDate ascending, with null signup dates last, then membershipId ascending. Use limit and offset to page through large exports. limit defaults to 500 and is capped at 1000.

Errors

400 - Member export is not available for this organization.
401 - Missing, invalid, or non-tenant-scoped API key.
500 - Internal server error.

Authorizations

Authorization

string

header

required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Query Parameters

status

enum<string>

default:all

Filter by current churn status. Invalid values are treated as all.

Available options:

all,

active,

churned

Inclusive lower bound on membership signup date. Date-only values start at 00:00:00.000Z.

Inclusive upper bound on membership signup date. Date-only values include the full UTC day.

limit

integer

default:500

Page size. Defaults to 500 and is capped at 1000.

Required range: 1 <= x <= 1000

offset

integer

default:0

Offset for pagination. Invalid negative values use 0.

Required range: x >= 0

Response

Member export response

organizationId

string

required

filters

object

required

Show child attributes

pagination

object

required

Show child attributes

members

object[]

required

Show child attributes

API documentation

Sites

Products

Checkout links

Purchases

Contacts

Marketing

Forms

Vouchers

Links

Automations

Surveys

Cases

Cancellations

Sonny's POS

Message

Email

Analytics

Integration

Response

Fields

Errors

Authorizations

Query Parameters

Response

​Response

​Fields

​Dates and pagination

​Errors

Authorizations

Query Parameters

Response

Response

Fields

Dates and pagination

Errors