API:people
From wiki.groundcrew.us
You're reading the API pages for Groundcrew
Returns per-person data for a given set of IDs.
Contents |
[edit] URL
http://wwww.groundcrew.us/api/squad/{squad_id}/people.json
[edit] HTTP Method(s)
GET
[edit] Parameters
| Required | Name | Type | Description |
|---|---|---|---|
| required | api_key | string | The authentication key associated with an organization. |
| ids | string | A comma-delimited list of internal person IDs (available via people/ids). Must be less than or equal to 1000 IDs. |
[edit] Response
The result is a Javascript hash, which includes an array of person hashes (about return values). Each person hash may have some or all of the keys shown in the example below.
Example JSON response:
{
"results": [
{
"id": "pedbe82b8576a",
"exid_prefix": "salsa",
"exid": "12345",
"name": "Noah",
"email": "noah@citizenlogistics.com",
"email_confirmed": true,
"email_sent": 2,
"phone": "+18001234567",
"phone_confirmed": true,
"sms_sent": 12,
"sms_receive": 8,
"msg": "at main st",
"msg_ts": 1258596496,
"sent": "okay!",
"sent_ts": 1258495982,
"lat": 42.3281968,
"lng": -72.6328569,
"loc": "01060",
"city": "Northampton, United States",
"loc_ts": 1257781206,
"cc2": "US",
"bio": "groundcrew dev",
"url": "http://groundcrew.us",
"thumb_url": "http://groundcrew.us/images/70/5c/705c553abea6e6a4cc44d2e06004f067_thumb.jpg",
"tags": ["organic", "social_movements"]
}]
}
[edit] Example
curl http://wwww.groundcrew.us/api/squad/{squad_id}/people.json?api_key={key}&ids=pedbe82b8576a,pe6cf2d71f2c7

