RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}

Member Areas API

Create, Retrieve, Update and Delete Member Areas via the public API endpoint using "where" filtering, as well as retrieve a Member Area's Content, Files and Members. Member Area content and members can also be added and removed, and file content secured and unsecured via this API.

`GET` Member Areas List

Retrieves a list of Member Areas as a JSON response based on your provided query parameters.

/api/v2/admin/member-areas

Parameters

Where

{<where query>}

Order_By

<propertyAlias>

Semantic_Query

<string>

Min_Score

<double>

Offset

<integer>

Limit

<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "LandingPageId": 0,
      "CountPaidSubscribers": 0,
      "MembersCount": 0,
      "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
      "ExpiryDateOption": "string",
      "ExpiryAfter": 0,
      "AccessType": "string",
      "PaymentInterval": "string",
      "Prices": [
        {
          "Value": 0,
          "CurrencyCountry": {
            "Hash": 0,
            "CurrencyId": "string",
            "Currency": "string",
            "CountryId": "string",
            "CountryAbbreviation": "string"
          }
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

`POST` Member Area Create

Creates a new Member Area based on the provided data.

/api/v2/admin/member-areas

Data / Response:

{
  "Name": "string",
  "LandingPageId": 0,
  "ExpiryDateOption": "string",
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryAfter": 0,
  "AccessType": "Free",
  "PaymentInterval": "None",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

{
  "Id": 0,
  "Name": "string",
  "LandingPageId": 0,
  "CountPaidSubscribers": 0,
  "MembersCount": 0,
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryDateOption": "string",
  "ExpiryAfter": 0,
  "AccessType": "string",
  "PaymentInterval": "string",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

`GET` Member Area Item

Retrieves a single Member Area based on the ID passed in the endpoint URL.

/api/v2/admin/member-areas/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Name": "string",
  "LandingPageId": 0,
  "CountPaidSubscribers": 0,
  "MembersCount": 0,
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryDateOption": "string",
  "ExpiryAfter": 0,
  "AccessType": "string",
  "PaymentInterval": "string",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

`PUT` Member Area Update

Updates a single Member Area based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/member-areas/{id}

Data / Response:

{
  "Name": "string",
  "LandingPageId": 0,
  "ExpiryDateOption": "string",
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryAfter": 0,
  "AccessType": "Free",
  "PaymentInterval": "None",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

{
  "Id": 0,
  "Name": "string",
  "LandingPageId": 0,
  "CountPaidSubscribers": 0,
  "MembersCount": 0,
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryDateOption": "string",
  "ExpiryAfter": 0,
  "AccessType": "string",
  "PaymentInterval": "string",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

`DELETE` Member Area Delete

Deletes a single Member Area based on the ID passed in the endpoint URL.

/api/v2/admin/member-areas/{id}

Data / Response:

N/A

Status 204

`GET` Member Area Content List

Retrieves a list of a Member Area's Content as a JSON response based on your provided query parameters.

/api/v2/admin/member-areas/{id}/content

Parameters

moduleId

<integer>

moduleAlias

<string>

Data / Response:

N/A

{
  "Secured": [
    {
      "Id": "string",
      "Url": "string"
    }
  ],
  "UnSecured": [
    {
      "Id": "string",
      "Url": "string"
    }
  ]
}

`POST` Member Area Content Create

Creates a new Member Area Content based on the provided data.

/api/v2/admin/member-areas/{id}/content

Data / Response:

{
  "ContentIds": [
    "string"
  ]
}

{
  "Id": 0,
  "Name": "string",
  "LandingPageId": 0,
  "CountPaidSubscribers": 0,
  "MembersCount": 0,
  "ExpiryDateTime": "2026-01-01T00:00:00.000Z",
  "ExpiryDateOption": "string",
  "ExpiryAfter": 0,
  "AccessType": "string",
  "PaymentInterval": "string",
  "Prices": [
    {
      "Value": 0,
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      }
    }
  ]
}

`DELETE` Member Area Content Delete

Deletes a single Member Area Content based on the ID passed in the endpoint URL.

/api/v2/admin/member-areas/{id}/content

Data / Response:

{
  "ContentIds": [
    "string"
  ]
}

Status 204

`GET` Member Area Files List

Retrieves a list of a Member Area's Files as a JSON response based on your provided query parameters.

/api/v2/admin/member-areas/{id}/files

Data / Response:

N/A

{
  "FolderContent": [
    {
      "LocationPath": "string",
      "Name": "string",
      "SizeBytes": 0,
      "Content": "string",
      "Extension": "string",
      "IsEmpty": true,
      "Url": "string",
      "LastWriteTime": "2026-01-01T00:00:00.000Z",
      "IsFolder": true,
      "SecureZoneIds": [
        "string"
      ]
    }
  ],
  "SecureZoneSecuredContent": [
    {
      "Id": "string",
      "Url": "string",
      "Extension": "string",
      "SecureZoneIds": [
        "string"
      ]
    }
  ]
}

`GET` Member Area Members List

Retrieves a list of a Member Area's Members as a JSON response based on your provided query parameters.

/api/v2/admin/member-areas/{id}/members

Parameters

Where

{<where query>}

Order_By

<propertyAlias>

Semantic_Query

<string>

Min_Score

<double>

Offset

<integer>

Limit

<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "Email": "user@example.com",
      "CreatedDateTime": "2026-01-01T00:00:00.000Z",
      "ExpiryDateTime": "2026-01-01T00:00:00.000Z"
    }
  ],
  "TotalItemsCount": 0
}

`POST` Member Area Add Members

Adds Members to a Member Area based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/member-areas/{id}/add-members

Data / Response:

{
  "SendNotification": true,
  "MemberIds": [
    "string"
  ],
  "SecureZonePointer": {
    "TypeId": 0,
    "InstanceId": 0
  }
}

Status 204

`DELETE` Member Area Remove Members

Removes Members from a Member Area based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/member-areas/{id}/remove-members

Data / Response:

{
  "MemberIds": [
    "string"
  ],
  "SecureZonePointer": {
    "TypeId": 0,
    "InstanceId": 0
  }
}

Status 204

`PUT` Member Area Secure Update

Updates a Member Area's secured content based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/member-areas/{id}/secure

Data / Response:

[
  {
    "Url": "string",
    "Extension": "string",
    "SecureZoneIds": [
      "string"
    ]
  }
]

[
  {
    "Id": "string",
    "Url": "string",
    "Extension": "string",
    "SecureZoneIds": [
      "string"
    ]
  }
]

`PUT` Member Area Unsecure Update

Updates a Member Area's unsecured content based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/member-areas/{id}/unsecure

Data / Response:

[
  {
    "Url": "string",
    "Extension": "string",
    "SecureZoneIds": [
      "string"
    ]
  }
]

[
  {
    "Id": "string",
    "Url": "string",
    "Extension": "string",
    "SecureZoneIds": [
      "string"
    ]
  }
]

`GET` Member Area Options Item

Retrieves the available options for Member Areas, including expiry options, access types, renewal rates and supported currencies.

/api/v2/admin/member-areas/options

Data / Response:

N/A

{
  "ExpiryOptions": [
    "string"
  ],
  "AccessType": [
    "string"
  ],
  "RenuwalRate": [
    {
      "AccessType": "None",
      "IsEnable": true,
      "DisplayName": "string"
    }
  ],
  "CountryCurrency": [
    {
      "Hash": 0,
      "CurrencyId": "string",
      "Currency": "string",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ]
}

GET Member Areas List

POST Member Area Create

GET Member Area Item

PUT Member Area Update

DELETE Member Area Delete

GET Member Area Content List

POST Member Area Content Create

DELETE Member Area Content Delete

GET Member Area Files List

GET Member Area Members List

POST Member Area Add Members

DELETE Member Area Remove Members

PUT Member Area Secure Update

PUT Member Area Unsecure Update

GET Member Area Options Item

`GET` Member Areas List

`POST` Member Area Create

`GET` Member Area Item

`PUT` Member Area Update

`DELETE` Member Area Delete

`GET` Member Area Content List

`POST` Member Area Content Create

`DELETE` Member Area Content Delete

`GET` Member Area Files List

`GET` Member Area Members List

`POST` Member Area Add Members

`DELETE` Member Area Remove Members

`PUT` Member Area Secure Update

`PUT` Member Area Unsecure Update

`GET` Member Area Options Item