You are here

Get a list of members

Use this to get a list of members of a specific site.

Method

Using the HTTP GET method:

sites/<siteId>/members

Example request URL

https://api.alfresco.com/yourcompany.com/public/alfresco/versions/1/sites/fred-bloggs-yourcompany-com/members

Response

  • If the siteId does not exist in this network, an HTTP Not Found (status 404) is returned.
  • If the request is successful an HTTP OK is returned (status 200).

Example response body

{
   "list":{
      "pagination":{
         "count":1,
         "hasMoreItems":false,
         "totalItems":-1,
         "skipCount":0,
         "maxItems":10
      },
      "entries":[
         {
            "entry":{
               "role":"SiteManager",
               "id":"fred.bloggs@yourcompany.com",
               "person":{
                     "enabled":true,
                     "lastName":"Bloggs",
                     "location":"Somewhere",
                     "avatarId":"6be34757-5764-4a4b-a86c-f5f0878b9700",
                     "instantMessageId":"fred",
                     "googleId":"fred@google.com",
                     "id":"fred.bloggs@yourcompany.com",
                     "skypeId":"fredbloggs",
                     "email":"fred.bloggs@yourcompany.com",
                     "description":"a person",
                     "company":{
                        "organization":"alfresco",
                        "address1":"somewhere",
                        "postcode":"fff fff",
                        "telephone":"01234 456789",
                        "fax":"01234 456789",
                        "email":"info@yourcompany.com"
                     },
                     "firstName":"Fred",
                     "telephone":"01234 99229922",
                     "jobTitle":"Chief Bottle Washer",
                     "mobile":"07777 012345"
               }
         }
      ]
   }
}