Skip to main content

Get all Account Memberships



You can also use include=account_member to retrieve details about the account members associated with the account memberships.

With this option, you can get more information about the account members such as name and email in a single request.


The following operators and attributes are available for filtering account memberships.

eqChecks whether the values of two operands are equal. If the values are equal, the condition is true.
likeChecks if the operand contains the specified string. You can use wildcard characters in operand.
account_member_idstringeq / likeeq(account_member_id,00000000-0000-1000-8000-0000000)


Query Parameters

    filter string

    Specifies the filter attributes.

    sort string

    Supported attributes are created_at, email, id, name, or updated_at. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with -, for example, -updated_at. The default sort order is created_at in descending order. For more information, see Sorting.

    page[limit] int64

    The number of records per page.

    page[offset] int64

    Possible values: <= 10000

    The number of records to offset the results by.



    data AccountMembershipResponse[]
  • Array [
  • id string

    Represents the unique identifier for the account membership.

    type string

    Default value: account_membership

    Represents the type of the object returned.

    meta object
    timestamps object
    created_at string

    The date the account is created.

    updated_at string

    The date the account is updated.

    relationships object
    account_member object
    data object
    id string

    Specifies the ID of the account member.

    type string

    Default value: account_member

    Specifies the type of the account member.

    links object
    self uri

    A URL to the specific resource.

  • ]
  • meta object
    page object
    limit integer

    The maximum number of records per page for this response. You can set this value up to 100.

    current integer

    The current page.

    offset integer

    The current offset by number of records, not pages. Offset is zero-based.

    total integer

    The total page count.

    results object
    total integer

    The total number of results after applying filters, if any, or all results.

    links object
    current uri

    Always the current page.

    first uri

    Always the first page.

    last uri

    Always null if there is only one page.

    next string

    Always null if there is only one page.

    prev string

    Always null if the user is on the first page.