Api::V1::Users::EntouragesController API

Entourages

Get entourages

GET /api/v1/users/:user_id/entourages

Parameters

Name Description
token token
user_id user
page page
per per
latitude Latitude
longitude Longitude
distance Distance from GPS coordinates from which Entourage should be found (km)
status open, closed, full, suspended, blacklisted

Request

Headers

Content-Type: application/json
Host: example.org
Cookie:

Route

GET /api/v1/users/174/entourages?token=foobar173

Query Parameters

token: foobar173

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Origin,Accept,Content-Type,X-Requested-With,X-CSRF-Token,X-API-KEY
Content-Type: application/json; charset=utf-8
ETag: W/"8b41e0d06d19d5ddefae847c3c170974"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c9fbdc21-773c-494d-9b1f-d450fe96114c
X-Runtime: 0.019790
Content-Length: 726

Status

200 OK

Body

{
  "entourages": [
    {
      "id": 37,
      "uuid": "eEsePXKGjuK8",
      "title": "Foobar",
      "group_type": "action",
      "entourage_type": "ask_for_help",
      "display_category": "social",
      "status": "open",
      "public": false,
      "metadata": {
        "city": "",
        "display_address": ""
      },
      "postal_code": null,
      "join_status": "not_requested",
      "number_of_unread_messages": 0,
      "number_of_people": 1,
      "created_at": "2022-06-02T17:16:46.640+02:00",
      "updated_at": "2022-06-02T17:16:46.640+02:00",
      "description": null,
      "share_url": "https://app.entourage.social/actions/eEsePXKGjuK8",
      "image_url": null,
      "online": false,
      "event_url": null,
      "display_report_prompt": false,
      "author": {
        "id": 174,
        "display_name": "John D.",
        "avatar_url": null,
        "partner": null,
        "partner_role_title": null
      },
      "location": {
        "latitude": 1.122,
        "longitude": 2.345
      }
    }
  ]
}