Link Search Menu Expand Document

Updated Fri Jun 18th 2021, 16:17 UTC

Users

GET /:account/users

Users can have Memberships to multiple Accounts. To retrieve all the Users with a Membership at a single Account, use this endpoint.

Examples

Getting the users belonging to a single account

Request

GET /my_account/users
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/users
    

Response

Status

200

Response Type

hydra:Collection

Example
{
  "@type": "hydra:Collection",
  "@context": "/contexts/hydra:Collection.jsonld",
  "id": "/my_account/users",
  "account": "/accounts/my_account",
  "members": [
    {
      "@type": "User",
      "@context": "/contexts/User.jsonld",
      "id": "/users/wqyODPA",
      "name": "Chuck Norris",
      "firstName": "Chuck",
      "lastName": "Norris",
      "email": "chuck@textus.example",
      "avatar": null,
      "automatedActor": false,
      "hasPassword": false,
      "discarded": false,
      "settings": {
        "notifications": {
          "email": true
        },
        "customSettings": {}
      },
      "memberships": "/users/wqyODPA/memberships"
    }
  ],
  "totalItems": 2
}

© 2021 TextUs