Link Search Menu Expand Document

Updated Fri Mar 5th 2021, 12:17 UTC

Index

GET /conversations/:conversation/assignments

Provides a list of all the assignments for a conversation

Examples

List Assigned Users on a Conversation

Request

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

Response

Status

200

Response Type

hydra:Collection

Example
{
  "@type": "hydra:Collection",
  "@context": "/contexts/hydra:Collection.jsonld",
  "id": "/conversations/Pvwqm5G/assignments",
  "members": [
    {
      "@type": "ConversationAssignment",
      "@context": "/contexts/ConversationAssignment.jsonld",
      "id": "/assignments/aB6MA91",
      "assignee": {
        "@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"
      },
      "assigner": "/users/wqyODPA"
    }
  ],
  "totalItems": 1
}

Table of contents


© 2021 TextUs