Membership¶

Get all membership records for the user¶

A typical configuration will have a single active membership record and a number of historic, (lapsed) records. However some configurations allow for multiple active memberships. If you are seeking to determine the membership status of a user check your configuration but usually it is sufficient to look for the first active membership.

http https://api.sheepcrm.com/api/v1/$FLOCK/user/{username}/membership/ "Authorization: Bearer $APP_API_TOKEN"

HTTP/1.1 200 OK
{
        List of all memberships
}

Create a membership record¶

membership_type: The URI of the membership type to create
start_date: When the membership should start (default = today)
amount: membership price (if not the list price)
currency: membership currency (if not the list currency)
status: starting status for the membership
member_org: use to create an organisational membership for the member

Note

As a safeguard the system won’t let you create two memberships of the same type for the same user starting on the same day.

http POST https://api.sheepcrm.com/api/v1/$FLOCK/user/{username}/membership/ "Authorization: Bearer $APP_API_TOKEN" membership_type=/example/membership_type/1234abc/

HTTP/1.1 201 CREATED
{

}

A single membership record¶

http https://api.sheepcrm.com/api/v1/$FLOCK/user/{username}/membership/{membership-uid}/ "Authorization: Bearer $APP_API_TOKEN"

HTTP/1.1 200 OK
{
        Single Membership
}

Linked members for a memberships¶

http https://api.sheepcrm.com/api/v1/$FLOCK/user/{username}/membership/{membership-uid}/linked/ "Authorization: Bearer $APP_API_TOKEN"

HTTP/1.1 200 OK
{
        Single Membership
}

Single linked members for a memberships¶

http https://api.sheepcrm.com/api/v1/$FLOCK/user/{username}/membership/{membership-uid}/linked/{link-uid}/ "Authorization: Bearer $APP_API_TOKEN"

HTTP/1.1 200 OK
{
        Single Membership
}