Contacts API: Memberships

Retrieves one specific membership

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

membershipstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/contacts/memberships/{membership}

HTTPcURLJavaScriptPython

GET /v2/e01/api/contacts/memberships/{membership} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific membership

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

membershipstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/contacts/memberships/{membership}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/contacts/memberships/{membership} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AccountScopestring · nullableOptional

MembershipEffectiveSincestring · date-time · nullableOptional

MembershipEffectiveBeforestring · date-time · nullableOptional

MembershipExpirySincestring · date-time · nullableOptional

MembershipExpiryBeforestring · date-time · nullableOptional

ModifiedSincestring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/contacts/memberships/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/memberships/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 322

{
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-05-09T19:46:25.843Z",
  "MembershipEffectiveBefore": "2026-05-09T19:46:25.843Z",
  "MembershipExpirySince": "2026-05-09T19:46:25.843Z",
  "MembershipExpiryBefore": "2026-05-09T19:46:25.843Z",
  "ModifiedSince": "2026-05-09T19:46:25.843Z",
  "ModifiedBefore": "2026-05-09T19:46:25.843Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "GroupId": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipId": "123e4567-e89b-12d3-a456-426614174000",
    "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipFunction": "text",
    "MembershipEffective": "2026-05-09T19:46:25.843Z",
    "MembershipExpiry": "2026-05-09T19:46:25.843Z",
    "Modified": "2026-05-09T19:46:25.843Z"
  }
]

Counts the memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AccountScopestring · nullableOptional

MembershipEffectiveSincestring · date-time · nullableOptional

MembershipEffectiveBeforestring · date-time · nullableOptional

MembershipExpirySincestring · date-time · nullableOptional

MembershipExpiryBeforestring · date-time · nullableOptional

ModifiedSincestring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/contacts/memberships/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/memberships/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 322

{
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-05-09T19:46:25.843Z",
  "MembershipEffectiveBefore": "2026-05-09T19:46:25.843Z",
  "MembershipExpirySince": "2026-05-09T19:46:25.843Z",
  "MembershipExpiryBefore": "2026-05-09T19:46:25.843Z",
  "ModifiedSince": "2026-05-09T19:46:25.843Z",
  "ModifiedBefore": "2026-05-09T19:46:25.843Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AccountScopestring · nullableOptional

MembershipEffectiveSincestring · date-time · nullableOptional

MembershipEffectiveBeforestring · date-time · nullableOptional

MembershipExpirySincestring · date-time · nullableOptional

MembershipExpiryBeforestring · date-time · nullableOptional

ModifiedSincestring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/contacts/memberships/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/memberships/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 322

{
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-05-09T19:46:25.843Z",
  "MembershipEffectiveBefore": "2026-05-09T19:46:25.843Z",
  "MembershipExpirySince": "2026-05-09T19:46:25.843Z",
  "MembershipExpiryBefore": "2026-05-09T19:46:25.843Z",
  "ModifiedSince": "2026-05-09T19:46:25.843Z",
  "ModifiedBefore": "2026-05-09T19:46:25.843Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AccountScopestring · nullableOptional

MembershipEffectiveSincestring · date-time · nullableOptional

MembershipEffectiveBeforestring · date-time · nullableOptional

MembershipExpirySincestring · date-time · nullableOptional

MembershipExpiryBeforestring · date-time · nullableOptional

ModifiedSincestring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/contacts/memberships/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/memberships/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 322

{
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-05-09T19:46:25.843Z",
  "MembershipEffectiveBefore": "2026-05-09T19:46:25.843Z",
  "MembershipExpirySince": "2026-05-09T19:46:25.843Z",
  "MembershipExpiryBefore": "2026-05-09T19:46:25.843Z",
  "ModifiedSince": "2026-05-09T19:46:25.843Z",
  "ModifiedBefore": "2026-05-09T19:46:25.843Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "MembershipId": "123e4567-e89b-12d3-a456-426614174000"
  }
]