Get a group

Returns a single contact group.

GET

https://app.touchsms.com.au/api/v2/groups/{group}

Authorization

basicAuth
HTTP
required

Path parameters

group
integer
required
Group ID.

Returns

200

The group.

JSON

data
optional
object
- id
  optional
  integer
- name
  optional
  string
- status
  optional
  boolean
  Whether the group is active.
- group_email
  optional
  string | null
  Email-to-SMS address that sends to every contact in the group.
  
  format: email
- is_global
  optional
  boolean
  Whether the group is shared across the whole account.
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

Get a group

curl --request GET \
  --url https://app.touchsms.com.au/api/v2/groups/512 \
  --header 'Authorization: Basic <credentials>'

const url = 'https://app.touchsms.com.au/api/v2/groups/512';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": 512,
    "name": "Customers",
    "status": true,
    "group_email": "group-512@example.com",
    "is_global": false,
    "updated": "2024-03-11T02:14:07Z",
    "created": "2024-02-02T23:51:19Z"
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "This action is unauthorized."
}

{
  "message": "Not Found"
}