Skip to main content
Browse the docs

List team memberships

GET/api/v1/memberships

  • Needs an API key, and runs with the access of the member who made the key.
  • A connected AI assistant can use it too, as listMemberships.

Parameters

In the query string

  • pageinteger

    Default: 1. At least 1.

  • per_pageinteger

    Default: 50. At least 1. At most 100.

Responses

200Paginated memberships.

  • dataarray of objectrequired

    Each item(10)

    • lock_versioninteger

      At least 0.

    • created_atstring (date-time)required

    • updated_atstring (date-time)required

    • idstring (uuid)required

    • account_idstring (uuid)required

    • userobjectrequired

      Fields(5)

      • idstring (uuid)required

      • namestringrequired

      • emailstring (email)required

      • time_zonestringrequired

      • has_passwordbooleanrequired

        False for people who only ever sign in with Google, Microsoft or Apple. Says which confirmation `deleteAccount` should ask for.

    • rolestringrequired

      One of: owner, office, technician.

    • calendar_colorstring or null

    • activebooleanrequired

    • invitedbooleanrequired

      True until the member sets a password from their invitation email.

  • metaobjectrequired

    Fields(4)

    • pageintegerrequired

      At least 1.

    • per_pageintegerrequired

      At least 1. At most 100.

    • totalintegerrequired

      At least 0.

    • total_pagesintegerrequired

      At least 0.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl "https://app.tradesender.co.uk/api/v1/memberships?page=1&per_page=50" \
  -H "Authorization: Bearer $TRADESENDER_KEY"