Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Contacts

GET /groups/:group/contacts

Note: This endpoint is still under active development, and may change without warning.

Retrieve the list of Contacts belonging to a Group

Examples

Get Group’s Contacts

Request

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

Response

Status

200

Response Type

hydra:Collection

Example
{
  "@type": "hydra:Collection",
  "id": "/groups/3D6ZO7/contacts",
  "@context": "/contexts/hydra:Collection.jsonld",
  "totalItems": 4,
  "members": [
    {
      "id": "/contacts/Vled2N",
      "@type": "Contact",
      "@context": "/contexts/Contact.jsonld",
      "name": "Jamel Hirthe",
      "firstName": "Jamel",
      "lastName": "Hirthe",
      "phones": {
        "id": "/contacts/Vled2N/phones",
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "totalItems": 1,
        "members": [
          {
            "@type": "ContactPhone",
            "id": "/contact_phones/mxvbRw",
            "@context": "/contexts/ContactPhone.jsonld",
            "phoneNumber": "+13035551234",
            "formattedPhoneNumber": "(303) 555-1234",
            "extension": null,
            "type": "Mobile",
            "deliverabilityStatus": "unknown",
            "contact": "/contacts/DQeeO69"
          }
        ]
      },
      "notes": {
        "@type": "hydra:Collection",
        "id": "/contacts/DQeeO69/notes",
        "@context": "/contexts/hydra:Collection.jsonld",
        "totalItems": 0,
        "members": [
          {
            "@type": "ContactNote",
            "id": "/contact_notes/RN5QNG",
            "@context": "/contexts/ContactNote.jsonld",
            "content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
            "createdAt": "2018-10-31T16:17:10.914Z",
            "updatedAt": "2018-10-31T16:17:10.914Z",
            "user": {
              "@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"
            },
            "contact": "/contacts/DQeeO69"
          }
        ]
      },
      "conversations": "/contacts/DQeeO69/conversations",
      "data": {},
      "createdAt": "2020-01-06T21:49:58.312Z"
    }
  ],
  "view": {
    "@type": "hydra:PartialCollectionView",
    "id": "/groups/1234/contacts",
    "@context": "/contexts/hydra:PartialCollectionView.jsonld",
    "first": "/groups/1234/contacts",
    "next": null,
    "previous": null
  }
}

© 2021 TextUs