Ctrlk
Shift iQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contacts API: Memberships

Retrieves one specific membership

get
Authorizations
BearerstringRequired
Path parameters
membershipstring · uuidRequired
Responses
200

OK

GroupIdstring · uuidOptional
MembershipIdstring · uuidOptional
ModifiedBystring · uuidOptional
UserIdstring · uuidOptional
MembershipFunctionstring · nullableOptional
MembershipEffectivestring · date-timeOptional
MembershipExpirystring · date-time · nullableOptional
Modifiedstring · date-timeOptional
LastChangeTimestring · date-timeOptional
LastChangeTypestring · nullableOptional
LastChangeUserstring · uuidOptional
get/api/contacts/memberships/{membership}
GET /v2/e01/api/contacts/memberships/{membership} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "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-01-01T00:00:00.000Z",
  "MembershipExpiry": "2026-01-01T00:00:00.000Z",
  "Modified": "2026-01-01T00:00:00.000Z",
  "LastChangeTime": "2026-01-01T00:00:00.000Z",
  "LastChangeType": "text",
  "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000"
}

Checks for the existence of one specific membership

head
Authorizations
BearerstringRequired
Path parameters
membershipstring · uuidRequired
Responses
200

OK

No content
head/api/contacts/memberships/{membership}
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

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to memberships modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. ModifiedSince and ModifiedBefore are also supported for the same purpose against the legacy Modified timestamp.

Authorizations
BearerstringRequired
Body
GroupIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
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
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

GroupIdstring · uuidOptional
MembershipIdstring · uuidOptional
ModifiedBystring · uuidOptional
UserIdstring · uuidOptional
MembershipFunctionstring · nullableOptional
MembershipEffectivestring · date-timeOptional
MembershipExpirystring · date-time · nullableOptional
Modifiedstring · date-timeOptional
LastChangeTimestring · date-timeOptional
LastChangeTypestring · nullableOptional
LastChangeUserstring · uuidOptional
post/api/contacts/memberships/collect
POST /v2/e01/api/contacts/memberships/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 518

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-01-01T00:00:00.000Z",
  "MembershipEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "MembershipExpirySince": "2026-01-01T00:00:00.000Z",
  "MembershipExpiryBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
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-01-01T00:00:00.000Z",
    "MembershipExpiry": "2026-01-01T00:00:00.000Z",
    "Modified": "2026-01-01T00:00:00.000Z",
    "LastChangeTime": "2026-01-01T00:00:00.000Z",
    "LastChangeType": "text",
    "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Counts the memberships that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the count to memberships modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. ModifiedSince and ModifiedBefore are also supported for the same purpose against the legacy Modified timestamp.

Authorizations
BearerstringRequired
Body
GroupIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
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
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/contacts/memberships/count
POST /v2/e01/api/contacts/memberships/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 518

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-01-01T00:00:00.000Z",
  "MembershipEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "MembershipExpirySince": "2026-01-01T00:00:00.000Z",
  "MembershipExpiryBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

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

Downloads the list of memberships that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to download only memberships modified within a specific window, which is useful for incremental integrations that already hold most of the data. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. ModifiedSince and ModifiedBefore are also supported against the legacy Modified timestamp. When polling for deltas, subtract a small overlap (for example five minutes) from the previous poll time to allow for projection lag.

Authorizations
BearerstringRequired
Body
GroupIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
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
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

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

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-01-01T00:00:00.000Z",
  "MembershipEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "MembershipExpirySince": "2026-01-01T00:00:00.000Z",
  "MembershipExpiryBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Searches for the list of memberships that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to memberships modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. ModifiedSince and ModifiedBefore are also supported for the same purpose against the legacy Modified timestamp.

Authorizations
BearerstringRequired
Body
GroupIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
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
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

GroupIdstring · uuidOptional
MembershipIdstring · uuidOptional
UserIdstring · uuidOptional
GroupNamestring · nullableOptional
GroupTypestring · nullableOptional
UserEmailstring · nullableOptional
UserNamestring · nullableOptional
post/api/contacts/memberships/search
POST /v2/e01/api/contacts/memberships/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 518

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "AccountScope": "text",
  "MembershipEffectiveSince": "2026-01-01T00:00:00.000Z",
  "MembershipEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "MembershipExpirySince": "2026-01-01T00:00:00.000Z",
  "MembershipExpiryBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

[
  {
    "GroupId": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "GroupName": "text",
    "GroupType": "text",
    "UserEmail": "text",
    "UserName": "text"
  }
]
PreviousContacts API: Groups
NextContacts API: People

Last updated

Was this helpful?