Groups
GET /:account/group_filters/:group_filter/groups{?q}
A Group is a named collection of Contacts.
This endpoint is also capable of searching group names.
Examples
Getting the index
Request
GET /my_account/group_filters/mine/groups?q=best
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /my_account/group_filters/mine/groups?q=best
Response
Status
200
Response Type
Example Body
{
"@type": "hydra:Collection",
"@context": "/contexts/hydra:Collection.jsonld",
"id": "/my_account/group_filters/mine/groups?q=best",
"members": [
{
"@type": "Group",
"@context": "/contexts/Group.jsonld",
"id": "/groups/6LR9Yj",
"name": "Test Group",
"slug": "6LR9Yj",
"createdAt": "2020-05-21T20:07:20.862Z",
"account": "/accounts/my_account",
"user": "/users/kY16Lm",
"contacts": {
"@type": "hydra:Collection",
"@context": "/contexts/hydra:Collection.jsonld",
"id": "/groups/nMjkXZ/contacts",
"totalItems": 1,
"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": {
"customSettings": {}
},
"memberships": "/users/wqyODPA/memberships"
},
"contact": "/contacts/DQeeO69"
}
]
},
"conversations": "/contacts/DQeeO69/conversations",
"data": {},
"createdAt": "2020-01-06T21:49:58.312Z",
"formattedData": {}
}
]
}
}
],
"totalItems": 1,
"view": {
"@type": "hydra:PartialCollectionView",
"@context": "/contexts/hydra:PartialCollectionView.jsonld",
"id": "/my_account/group_filters/mine/groups?q=best",
"first": "/my_account/group_filters/mine/groups",
"next": null,
"previous": null
}
}