Skip to main content
Glama

List customer memberships

goteamup_list_customer_memberships
Read-only

List memberships held by customers — status (active, hold, complete, cancelled), start/expiration/renewal dates, billed price, active hold. Filter by customer, membership plan, type, status, dates or holds. TeamUp: GET /customer_memberships.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoOnly these customer membership ids.
pageNoPage number, starting at 1.
sortNoOrdering; '-' for descending.
expandNoComma-separated related fields to expand into full objects (dot-nested, max depth 4), e.g. customer,event.instructors.
fieldsNoComma-separated fields to return (dot notation for nested), e.g. id,name,starts_at.
statusNoCustomer membership status.
customerNoOnly these customer ids.
page_sizeNoResults per page, 1-100 (default 100).
membershipNoOnly these membership (plan) ids.
start_date_gteNoStart date on or after (date, YYYY-MM-DD).
start_date_lteNoStart date on or before (date, YYYY-MM-DD).
has_active_holdNoOnly memberships with (true) or without (false) a current or upcoming hold.
membership_typeNoMembership type.
expiration_date_gteNoExpiration date on or after (date, YYYY-MM-DD).
expiration_date_lteNoExpiration date on or before (date, YYYY-MM-DD).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The readOnlyHint annotation already tells the agent this is a safe read, so the burden is lower. The description usefully discloses the returned data surface (status, start/expiration/renewal dates, billed price, active hold) and the backing endpoint GET /customer_memberships, but says nothing about pagination behavior or the default page size of 100 that the schema exposes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences that front-load the scope ('List memberships held by customers') followed by the filter dimensions. The trailing endpoint reference is mildly redundant but compact, and there is no filler prose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 15-parameter read-only list tool with no output schema, the description covers purpose, filterable axes, and the shape of the returned record, which is enough for an agent to call it correctly. Only pagination/sorting behavior is left entirely to the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so every parameter including page, page_size, sort, expand and fields is already documented. The description only restates the filter categories at a high level and adds no syntax, formatting, or default-value detail beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List memberships held by customers') and names the concrete data it returns (status, dates, billed price, hold). It does not explicitly distinguish itself from the sibling goteamup_list_memberships, which an agent could easily confuse with this tool, but the 'customer memberships' phrasing is reasonably precise.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description enumerates the filtering dimensions (customer, plan, type, status, dates, holds), which implies when the tool is useful, but it never states when to use this versus goteamup_list_memberships or goteamup_get_customer_membership, nor any exclusions or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.