The membership object

A comprehensive list of the membership resource's attributes and relationships

A membership object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/memberships endpoint.

Fields

Field	Type	Description
type	string	memberships
id	string	The membership unique identifier.
links.self	string	The membership endpoint URL.
attributes.user_email	string	The user email.
attributes.user_first_name	string	The user first name.
attributes.user_last_name	string	The user last name.
attributes.status	string	The memberships status. One of pending (default), active.
attributes.owner	boolean	Indicates if the user it's the owner of the organization.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.organization	object	The organization associated to the membership.
relationships.role	object	The role associated to the membership.
relationships.application_memberships	array	The application memberships associated to the membership.
relationships.versions	array	The associated changes.