About the Followers API

The Members Follow API allows site members to follow and unfollow each other. When a site member follows another member, they receive activity notifications from the members they follow.

With the Members Followers API, you can:

Before you begin

It’s important to note the following points before starting to code:

Use cases

Did this help?

Members Followers: Sample use cases & Flows

This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.

Your app could assist site owners in adding a widget that displays connections of connections, along with the number of connections a member shares in common with them.

  1. Retrieve all members of a site by calling the List Members endpoint.
  2. For each member, retrieve their followers using the List Member Followers endpoint, count them, and sort the results by the highest number of followers.

Create a “People you may know” widget based on 2nd-degree connections

Your app could help site owners add a widget showing connections of connections, and how many connections the specified member has in common with them.

  1. Get the specified member's connections using the List Member Followers endpoint and the List Member Following endpoint.

  2. For each direct connection, get their connections in both directions, using the same endpoints as in step 1.

  3. Using the list of indirect connections from step 2, query any existing relationships to the specified member, using the Query Member Connections endpoint.

  4. Sort the resulting list of potential connections into the following sets:

    • The specified member already follows the second-degree connection. Remove them from the suggestion list.
    • The second-degree connection follows the specified member. Add to a "follows you" sub-list.
    • There is not yet any direct connection to the second-degree connection. These are the members to use for the suggestion list.
  5. For each remaining suggestion, use the List Members endpoint to display details for the specified member, and provide "Follow this Member" links using the Follow Member endpoint.

Did this help?

Follow Object


Members Follow APIs

Properties
memberIdstringformat GUID

Member ID of the member who performed the action.


affectedMemberIdstringformat GUID

Member ID of the member being followed or unfollowed.

Follower
JSON
{ "memberId": "e411fe13-9794-42b6-ad62-72c9917f1bac", "affectedMemberId": "9374ed3f-c6c2-4d7d-86f6-4208f70568da" }
Did this help?

GET

List Member Followers


Lists members who are following the given member.

Permissions
Manage Members
Read Member Connections
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v3/followers/{memberId}

Path Params
memberIdstringRequired

The ID of the member whose followed members you want to list.

Query Params
paging.limitintegerminimum 1maximum 100format int32

Number of items to return. See Pagination for more information.


paging.cursorstring

Cursor returned from last query response.

Response Object
memberIdsArray <string>format GUID

List of members who are following the given member.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

List Member Followers
Request
cURL
curl -X GET \ 'https://www.wixapis.com/members/v3/followers/24d1fada-b1fb-44e3-ab31-d48b243b9d34' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "memberIds": [ "550993c0-49de-444d-8301-8ac7e3ecdc51", "f7e6f0e5-1247-41e5-89d2-99deefbef9c4" ], "pagingMetadata": { "count": 2, "hasNext": false } }
Did this help?

POST

Follow Member


Sets the current member to follow another member.

Endpoint
POST
https://www.wixapis.com/members/v3/followers/{memberId}

Path Params
memberIdstringRequired

The ID of the member who you want to follow.

Response Object
Returns an empty object.
Follow Member
Request
cURL
curl -X POST \ 'https://www.wixapis.com/members/v3/followers/6f598508-24f1-438d-bd15-fa976190cdc1' \ -H 'Authorization: <AUTH>'
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

DELETE

Unfollow Member


Sets the current member to unfollow another member.

Endpoint
DELETE
https://www.wixapis.com/members/v3/followers/{memberId}

Path Params
memberIdstringRequired

The ID of the member who you want to unfollow.

Response Object
Returns an empty object.
Unfollow Member
Request
cURL
curl -X DELETE \ 'https://www.wixapis.com/members/v3/followers/6f598508-24f1-438d-bd15-fa976190cdc1' \ -H 'Authorization: <AUTH>'
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

GET

List My Member Following


Lists members who are followed by the current member.

Permissions
Manage Members
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v3/followers/my/following

Query Params
paging.limitintegerminimum 1maximum 100format int32

Number of items to return. See Pagination for more information.


paging.cursorstring

Cursor returned from last query response.

Response Object
memberIdsArray <string>format GUID

List of members followed by the current member.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

List My Member Following
Request
cURL
curl -X GET \ 'https://www.wixapis.com/members/v3/followers/my/following' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "memberIds": [ "550993c0-49de-444d-8301-8ac7e3ecdc51", "f7e6f0e5-1247-41e5-89d2-99deefbef9c4" ], "pagingMetadata": { "count": 2, "hasNext": false } }
Did this help?

GET

List Member Following


Lists members who are followed by the given member.

Permissions
Manage Members
Read Member Connections
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v3/followers/{memberId}/following

Path Params
memberIdstringRequired

The ID of the member whose followers you want to list.

Query Params
paging.limitintegerminimum 1maximum 100format int32

Number of items to return. See Pagination for more information.


paging.cursorstring

Cursor returned from last query response.

Response Object
memberIdsArray <string>format GUID

List of members who are followed by the given member.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

List Member Following
Request
cURL
curl -X GET \ 'https://www.wixapis.com/members/v3/followers/24d1fada-b1fb-44e3-ab31-d48b243b9d34/following' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "memberIds": [ "550993c0-49de-444d-8301-8ac7e3ecdc51", "f7e6f0e5-1247-41e5-89d2-99deefbef9c4" ], "pagingMetadata": { "count": 2, "hasNext": false } }
Did this help?

GET

List My Member Followers


Lists members who are following the current member.

Permissions
Manage Members
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v3/followers/my

Query Params
paging.limitintegerminimum 1maximum 100format int32

Number of items to return. See Pagination for more information.


paging.cursorstring

Cursor returned from last query response.

Response Object
memberIdsArray <string>format GUID

List of members who are following the current member.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

List My Member Followers
Request
cURL
curl -X GET \ 'https://www.wixapis.com/members/v3/followers/my' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "memberIds": [ "550993c0-49de-444d-8301-8ac7e3ecdc51", "f7e6f0e5-1247-41e5-89d2-99deefbef9c4" ], "pagingMetadata": { "count": 2, "hasNext": false } }
Did this help?

POST

Query My Member Connections


Retrieves a list of members whose connections to the current member were retrieved.

Permissions
Manage Members
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v3/followers/my/connections

Body Params
connectedMemberIdsArray <string>Requiredformat GUIDmaxItems 100

List of member IDs whose connections to the current member will be retrieved.

Response Object
connectedMembersArray <ConnectedMembers>

List of members whose connections to the current member were retrieved.

Query My Member Connections
Request
cURL
curl -X POST \ 'https://www.wixapis.com/members/v3/followers/my/connections?connectedMemberIds=27142d62-fecd-4607-afe1-05c45cff8d95' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' -d $'{ "connectedMemberIds": [ "abc688da-ff74-43c6-9262-4ce2b5d2606", "27142d62-fecd-4607-afe1-05c45cff8d95" ] }'
Response
JSON
{ "connectedMembers": [ { "connectedMemberId": "abc688da-ff74-43c6-9262-4ce2b5d26076", "followedByMember": false, "followingMember": false }, { "connectedMemberId": "27142d62-fecd-4607-afe1-05c45cff8d95", "followedByMember": true, "followingMember": true } ] }
Did this help?

POST

Query Member Connections


Retrieves a list of members whose connections to the given member were retrieved.

Note: If an empty array is passed as connectedMemberIds, the call will succeed, but it will not return any data.

Permissions
Manage Members
Read Member Connections
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v3/followers/{memberId}/connections

Path Params
memberIdstringRequired

Member ID.

Body Params
connectedMemberIdsArray <string>Requiredformat GUIDmaxItems 100

List of member IDs whose connections to the given member will be retrieved.

Response Object
connectedMembersArray <ConnectedMembers>

List of members whose connections to the given member were retrieved.

Query Member Connections
Request
cURL
curl -X POST \ 'https://www.wixapis.com/members/v3/followers/24d1fada-b1fb-44e3-ab31-d48b243b9d34/connections' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' -d $'{ "connectedMemberIds": [ "27142d62-fecd-4607-afe1-05c45cff8d95", "abc688da-ff74-43c6-9262-4ce2b5d2606" ] }'
Response
JSON
{ "connectedMembers": [ { "connectedMemberId": "abc688da-ff74-43c6-9262-4ce2b5d26076", "followedByMember": false, "followingMember": false }, { "connectedMemberId": "27142d62-fecd-4607-afe1-05c45cff8d95", "followedByMember": true, "followingMember": true } ] }
Did this help?

Follow Member Followed


Triggered when a member follows another member.

Permissions
Manage Members
Read Member Connections
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.members.v3.follow.


slugstring

Event name. Expected member_followed.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.members.v3.follow_member_followed", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

JSON
{ "id": "0ec75a41-ae29-4e5e-8063-46f5a5d925d9", "entityFqdn": "wix.members.follow", "slug": "member_followed", "entityId": "b684ab69-b157-419f-ac29-79878632a97d", "actionEvent": { "body": { "memberConnection": { "memberId": "f2f267d8-3b46-4af8-991e-a00d9232ef4e", "affectedMemberId": "b458556b-d0bc-4644-a057-bf4db5b0eec9" } } }, "eventTime": "2021-08-30T08:44:20.629071Z", "triggeredByAnonymizeRequest": false }
Did this help?

Follow Member Unfollowed


Triggered when a member unfollows another member.

Permissions
Manage Members
Read Member Connections
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.members.v3.follow.


slugstring

Event name. Expected member_unfollowed.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.members.v3.follow_member_unfollowed", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

JSON
{ "id": "0ec75a41-ae29-4e5e-8063-46f5a5d925d9", "entityFqdn": "wix.members.v3.follow", "slug": "member_unfollowed", "entityId": "b684ab69-b157-419f-ac29-79878632a97d", "actionEvent": { "body": { "memberConnection": { "memberId": "f2f267d8-3b46-4af8-991e-a00d9232ef4e", "affectedMemberId": "b458556b-d0bc-4644-a057-bf4db5b0eec9" } } }, "eventTime": "2021-08-30T08:44:20.629071Z", "triggeredByAnonymizeRequest": false }
Did this help?