API Reference

Object Definitions

Below are summarized definitions of different objects within Join It.

In each Summary is a link to a more detailed description and data model.

‍

Memberships

Within Join It, the Memberships object is the most central data object. It's the object that is most frequently synced to 3rd party systems and stores information of the Membership (both profile information and things like Status, Expiration Date, Rebilling Date).

View More Information and Data Model

‍

Members

Within Join It, the Members Object stores important associations but is less represented in the user interface. However, the Members Object stores the association between a User (account login) and an Organization, as well as storing the association between Payments and stored Payment Methods.

View More Information and Data Model

‍

Membership Types

Within Join It, the Membership Types Object are set up by Organizations to define the parameters for Memberships to be created in their Organization.

In layman's terms, an Organization might think of Membership Types as their different tiers or levels that they use to classify their Memberships.

View More Information and Data Model

‍

Payments

[Coming Soon]

Endpoint Definitions

GET Webhooks

Retrieves the Webhooks on behalf of an Organization.

/v1/organizations/:organization_id/webhooks

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token

GET Questions

Retrieves the available Questions on behalf of an Organization.

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token

GET Memberships

Retrieves the Memberships on behalf of an Organization.

/v1/organizations/:organization_id/memberships

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token

GET Payments

Retried the Membership Payments for an Organization

/v1/organizations/:organization_id/payments

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token

‍

GET Membership Types

Retrieve the Membership Types associated with an Organization

/v1/organizations/:organization_id/membership_types

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token

GET Organization Details

Retrieve the details on an Organization. Typically used to fetch details on the Organization that owns the token being used.

/v1/organizations/:organization_id/details

:organization_id - Required - Pass in the ID of the Organization that you're trying to fetch or use 'me' to fetch the Organization that owns the token