Speakap v1.8.2

Retrieve Originators of Alert Collection (since 1.0.24)

GET https://api.speakap.io/networks/:eid/alerts/:eid/originators/

Since

1.0.24

Request

URI:/networks/{networkEID}/alerts/{alertEID}/originators/
Method:GET
Accept:application/vnd.speakap.api-v1.8.2+json+hal
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID
alertEID EID Alert EID

Sorting

Name Type Description
fullName string Order by originators’ full names

Response

200
Returns a collection of User resources
403
Unauthorized: returns an Error object
404
Unknown network or alert: returns an Error object

Example (with embedding)

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/alerts/1234567890ABCDEF/originators/"
        }
    },
    "_embedded": {
        "originators": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.speakap.io/networks/FEDCBA0987654321/users/ABCDEF0123456789/"
                    }
                },
                "EID": "ABCDEF0123456789",
                "primaryEmail": "johnsmith@outlook.com",
                "name": {
                    "firstName": "John",
                    "infix": "",
                    "familyName": "Smith"
                },
                "fullName": "John Smith",
                "deleted": false,
                "external": false,
                "lastModified": "2015-07-02T11:35:30.123+01:00"
            }
        ]
    }
}