API resources: Member statuses

The Member Statuses resource returns the member statuses in your MC Professional database through the API.

Overview

The MC Professional API Member Status resource allows a 3rd party client to get the list of profile membership statuses.  Every profile is set to one of the member statuses.

Get a list of member statuses

This resource returns the complete list of member statuses.

Scope

To access this resource, the access token must have the read scope.

Permissions

This resource is available to administrators.

Request

The request to get a list of member statuses is an HTTP GET to the /api/v1/member-status endpoint.  The following is the format of the request:

GET /api/v1/member-status HTTP/1.1
Host: <orgId>.memberclicks.net
Accept: application/json
Authorization: Bearer <accessToken>
Cache-Control: no-cache

• orgId: the MC Professional organization ID
• accessToken: the access token issued by the authorization server

Example

Using the example values below, the following is the resulting request:

• orgId: apiexample
• accessToken: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NjcyMjU5MTcsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiI1ZWUyMzAyMC0xNzIwLTRlYzUtYWFiZi0wY2M3YjVmYTZmZTEiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.Sz7ESorug0J76mzG8wiL-TVYYPPGgX1FNX-Nd7ppjCg

GET /api/v1/member-status HTTP/1.1
Host: apiexample.memberclicks.net
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NjcyMjU5MTcsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiI1ZWUyMzAyMC0xNzIwLTRlYzUtYWFiZi0wY2M3YjVmYTZmZTEiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.Sz7ESorug0J76mzG8wiL-TVYYPPGgX1FNX-Nd7ppjCg
Cache-Control: no-cache

Response

A successful request will return an HTTP status 200 OK with the response in the following format:

HTTP/1.1 200 OK

{
  "totalCount": <totalCount>,
  "memberStatuses": <memberStatuses>
}

• totalCount: the total count of member statuses
• memberStatuses: the array of member statuses.  Each object in the array contains the member status name.

Example

The following is the response for the example request above:

HTTP/1.1 200 OK

{
  "totalCount": 5,
  "memberStatuses": [
    {
      "name": "Pending"
    },
    {
      "name": "Active"
    },
    {
      "name": "Graced"
    },
    {
      "name": "Lapsed"
    },
    {
      "name": "Deceased"
    }
  ]
}