Members

List a project's members

curl "https://api.subscriby.net/v1/projects/$PROJECT_ID/members?status=customer" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Newest first, paged with page and per_page (default 25; limit is accepted as an alias). status narrows to one lifecycle state. identity looks one member up by the account they connected, connector:external_id, for a workflow that starts from a platform event and needs the member behind an account id; the page then holds that one member with their identities embedded, or no rows.

get/v1/projects/{project}/members

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/members
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

status'lead' | 'trialing' | 'customer' | 'churned' | 'banned'
Example:customer

Narrow the page to one lifecycle state: lead, trialing, customer, churned or banned. Any other value is refused rather than answered with an empty page, so a typo in an automation is noticed.

identitystring nullable

Find the member who connected a given account: the connector key and the platform's own id for the account joined by a colon, connector:123456789. The page then holds that one member with their identities embedded, or no rows when nobody in the project connected that account. A value with no connector before the colon is refused.

pageinteger

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Response

The page, newest first; one row or none when narrowed to an account, with its connected accounts embedded.

Example response

{
  "data": [
    {
      "id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
      "username": "@janedoe",
      "first_name": "Jane",
      "last_name": "Doe",
      "billing_email": "jane@example.com",
      "identities": [
        {
          "id": "6a1f0c3e-2d4b-4e8a-9c7d-1b5e3f9a2c4d",
          "connector": "telegram",
          "source": "handshake",
          "preferred": true,
          "external_id": "123456789",
          "display_name": "Jane Doe",
          "username": "janedoe",
          "linked_at": "2026-05-18T10:05:00Z"
        }
      ],
      "status": "customer",
      "joined_at": "2026-05-18T10:05:00Z",
      "created_at": "2026-05-18T10:05:00Z",
      "updated_at": "2026-05-18T10:05:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.