API resources: Member types

The Member Types resource returns the member types in your MC Professional database through the API.

Overview

The MC Professional API Member Type resource allows a 3rd party client to get the list of member types.  Every profile is assigned to a member type.

Get a list of member types

This resource returns the complete list of member types.

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 types is an HTTP GET to the /api/v1/member-type endpoint.  The following is the format of the request:

GET /api/v1/member-type 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.eyJleHAiOjE0NjcyOTU0OTcsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiIxNmVhN2E2ZS0zNTZmLTRlODgtOTAyYy03ZDRhOTY1ZDQyNWIiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.aR75nD32nUAZO4W8ssHulIv7JJv7QEQhuOgi-FcXJIY

GET /api/v1/member-type HTTP/1.1
Host: apiexample.memberclicks.net
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NjcyOTU0OTcsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiIxNmVhN2E2ZS0zNTZmLTRlODgtOTAyYy03ZDRhOTY1ZDQyNWIiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.aR75nD32nUAZO4W8ssHulIv7JJv7QEQhuOgi-FcXJIY
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>,
  "memberTypes": <memberTypes>
}

• totalCount: the total count of member types
• memberTypes: the array of member types.  Each object in the array contains the member type name and type.

Example

The following is the response for the example request above:

HTTP/1.1 200 OK

{
  "totalCount": 9,
  "memberTypes": [
    {
      "name": "Admin",
      "type": "Individual"
    },
    {
      "name": "Associate",
      "type": "Individual"
    },
    {
      "name": "Company",
      "type": "Organization"
    },
    {
      "name": "Contacts",
      "type": "Linked"
    },
    {
      "name": "Employee",
      "type": "Linked"
    },
    {
      "name": "Member",
      "type": "Individual"
    },
    {
      "name": "Organization",
      "type": "Organization"
    },
    {
      "name": "Prospect",
      "type": "Prospect"
    },
    {
      "name": "Student",
      "type": "Individual"
    }
  ]
}