List Shares

By December 7, 2017Sharing

Lists the people that have access to a site.

URL

GET https://secure.gaug.es/gauges/:id/shares

Request

curl -H "X-Gauges-Token: <token>" https://secure.gaug.es/gauges/:id/shares

Response

{
  "shares": [{
    "name": "John Doe",
    "id": "4e206261e5947c1d38000001",
    "type": "user",
    "last_name": "Doe",
    "email": "john@doe.com",
    "first_name": "John",
    "urls": {
      "remove": "https://secure.gaug.es/gauges/4ea97a8be5947ccda1000001/shares/4e206261e5947c1d38000001"
    }
  }]
}

Share Site

Shares site with a person by their email. Any valid email will work and will receive an invite even if there is no existing Gauges user with that email.

Parameters

email required The email of the person to add

URL

POST https://secure.gaug.es/gauges/:id/shares

Request

curl -H "X-Gauges-Token: <token>" \
     -d "email=jane@doe.com" \
     https://secure.gaug.es/gauges/:id/shares

Response

{
  "share": {
    "name": "jane@doe.com",
    "id": "4eaae4c4e5947c72f7000001",
    "type": "invite",
    "last_name": null,
    "email": "jane@doe.com",
    "first_name": null,
    "urls": {
      "remove": "https://secure.gaug.es/gauges/4ea97a8be5947ccda1000001/shares/4e206261e5947c1d38000001"
    }
  }
}

Un-share Site

URL

DELETE https://secure.gaug.es/gauges/:id/shares/:user_id

Request

curl -H "X-Gauges-Token: <token>" \
     -X DELETE \
     https://secure.gaug.es/gauges/:id/shares/:user_id

Response

{
  "share": {
    "name": "jane@doe.com",
    "id": "4eaae4c4e5947c72f7000001",
    "type": "invite",
    "last_name": null,
    "email": "jane@doe.com",
    "first_name": null,
    "urls": {
      "remove": "https://secure.gaug.es/gauges/4ea97a8be5947ccda1000001/shares/4e206261e5947c1d38000001"
    }
  }
}

Leave a Reply