Memberships

Endpoints related to account hub memberships, such as sending invitations to hubs or listing the hubs your account is a member of.

List Account Invites

Lists the pending Hub Memberships (also known as Invites) associated with the Account.

SecuritybearerAuth
Request
query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "capabilities"
include
Array of strings
Items Enum: "senders" "hubs" "accounts" "roles"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

filter
object
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of pending Hub Memberships.

default

General error response from the platform

get/v1/account/invites
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Accept or Reject an Invite

Accept/reject a pending Invite to join a Hub.

SecuritybearerAuth
Request
path Parameters
inviteId
required
string

The ID of the given Invite.

query Parameters
include
Array of strings
Items Enum: "senders" "hubs" "accounts" "roles"
Request Body schema: application/json
accept
boolean

If true, the Invite will be accepted and the associated Account will join the Hub.

decline
boolean

If true, the Invite will be declined and the associated Account will NOT join the Hub.

Responses
200

Returns a Hub Membership.

default

General error response from the platform

patch/v1/account/invites/{inviteId}
Request samples
application/json
{
  • "accept": true,
  • "decline": true
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Get Account Memberships

Lists the Hub Memberships for a given account.

SecuritybearerAuth
Request
query Parameters
include
Array of strings
Items Enum: "senders" "hubs" "accounts" "roles"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

filter
object
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Hub Memberships associated with the Account.

default

General error response from the platform

get/v1/account/memberships
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}