Team

List all teams for the current account

get/teams

Request

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Team ID

public_idstring nullable

Team public ID

namestring

The name of your Team

time_zonestring nullable

The human-readable time zone set manually by a ClickFunnels user or dynamically by the app. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..

locale'en' | 'ja'

The main language used to create a new website.

created_atstring date-time nullable

Created

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 42000,
    "public_id": "ClNcfI",
    "name": "Example Team",
    "time_zone": "Pacific Time (US & Canada)",
    "locale": "en",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "billing_subscriptions": [
      {
        "id": 8000,
        "public_id": "SbTcfQ",
        "team_id": 42000,
        "status": "active",
        "cycle_ends_at": "2025-02-01T00:00:00.000Z",
        "created_at": "2025-01-01T00:00:00.000Z",
        "updated_at": "2025-01-01T00:00:00.000Z",
        "included_prices": [
          {
            "id": 9000,
            "subscription_id": 8000,
            "price_id": "price_basic_monthly",
            "quantity": 1,
            "created_at": "2025-01-01T00:00:00.000Z",
            "updated_at": "2025-01-01T00:00:00.000Z"
          }
        ]
      }
    ],
    "memberships": [
      {
        "id": 5000,
        "public_id": "MbRcfK",
        "team_id": 42000,
        "user_id": 1,
        "user_first_name": "Lili",
        "user_last_name": "Stiedemann",
        "user_profile_photo_id": null,
        "user_email": "test@email.com",
        "added_by_id": null,
        "platform_agent_of_id": null,
        "role_ids": [
          "admin"
        ],
        "created_at": "2025-01-01T00:00:00.000Z",
        "updated_at": "2025-01-01T00:00:00.000Z",
        "user": {
          "id": 1,
          "public_id": "prbtEx",
          "email": "test@email.com",
          "first_name": "Lili",
          "last_name": "Stiedemann",
          "time_zone": "Pacific Time (US & Canada)",
          "locale": "en",
          "created_at": "2025-01-01T00:00:00.000Z",
          "updated_at": "2025-01-01T00:00:00.000Z"
        }
      }
    ]
  }
]

Changes

    • info

      added the new optional query request parameter per_page

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the pt enum value from the / response property for the response status