Directory: Memberships

get

Authorizations

BearerCookie

Path parameters

membershipstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships/{membership} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MembershipFunction": "text",
  "MembershipEffective": "2025-08-14T15:09:24.594Z",
  "MembershipExpiry": "2025-08-14T15:09:24.594Z"
}

head

Authorizations

BearerCookie

Path parameters

membershipstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/memberships/{membership} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

MembershipFunctionstringOptional

MembershipEffectivestring · date-timeOptional

MembershipExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

MembershipFunctionstringOptional

MembershipEffectivestring · date-timeOptional

MembershipExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipFunction": "text",
    "MembershipEffective": "2025-08-14T15:09:24.594Z",
    "MembershipExpiry": "2025-08-14T15:09:24.594Z"
  }
]

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

MembershipFunctionstringOptional

MembershipEffectivestring · date-timeOptional

MembershipExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

Path parameters

deletionstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-deletions/{deletion} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "DeletionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "DeletionWhen": "2025-08-14T15:09:24.594Z"
}

head

Authorizations

BearerCookie

Path parameters

deletionstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/memberships-deletions/{deletion} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

MembershipIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

DeletionWhenstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-deletions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

MembershipIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

DeletionWhenstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-deletions HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "DeletionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "DeletionWhen": "2025-08-14T15:09:24.594Z"
  }
]

get

Authorizations

BearerCookie

Query parameters

GroupIdentifierstring · uuidOptional

MembershipIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

DeletionWhenstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-deletions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

Path parameters

reasonstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-reasons/{reason} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "ReasonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LastChangeType": "text",
  "PersonOccupation": "text",
  "ReasonSubtype": "text",
  "ReasonType": "text",
  "Created": "2025-08-14T15:09:24.594Z",
  "Modified": "2025-08-14T15:09:24.594Z",
  "ReasonEffective": "2025-08-14T15:09:24.594Z",
  "ReasonExpiry": "2025-08-14T15:09:24.594Z"
}

head

Authorizations

BearerCookie

Path parameters

reasonstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/memberships-reasons/{reason} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

Query parameters

CreatedBystring · uuidOptional

MembershipIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

LastChangeTypestringOptional

PersonOccupationstringOptional

ReasonSubtypestringOptional

ReasonTypestringOptional

Createdstring · date-timeOptional

Modifiedstring · date-timeOptional

ReasonEffectivestring · date-timeOptional

ReasonExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-reasons/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

Query parameters

CreatedBystring · uuidOptional

MembershipIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

LastChangeTypestringOptional

PersonOccupationstringOptional

ReasonSubtypestringOptional

ReasonTypestringOptional

Createdstring · date-timeOptional

Modifiedstring · date-timeOptional

ReasonEffectivestring · date-timeOptional

ReasonExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-reasons HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "ReasonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "LastChangeType": "text",
    "PersonOccupation": "text",
    "ReasonSubtype": "text",
    "ReasonType": "text",
    "Created": "2025-08-14T15:09:24.594Z",
    "Modified": "2025-08-14T15:09:24.594Z",
    "ReasonEffective": "2025-08-14T15:09:24.594Z",
    "ReasonExpiry": "2025-08-14T15:09:24.594Z"
  }
]

get

Authorizations

BearerCookie

Query parameters

CreatedBystring · uuidOptional

MembershipIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

LastChangeTypestringOptional

PersonOccupationstringOptional

ReasonSubtypestringOptional

ReasonTypestringOptional

Createdstring · date-timeOptional

Modifiedstring · date-timeOptional

ReasonEffectivestring · date-timeOptional

ReasonExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/memberships-reasons/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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