people.md

People

Retrieving People (GET)

Get all People in the Organization

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people

Get a Specific Person

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people/$PERSON_ID

Filtering by Circle (circle_id=)

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people?circle_id=$CIRCLE_ID

OR

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/circles/$CIRCLE_ID/people

Filtering by Role (role=)

The API supports retrieving all role-fillers of core roles in the organization.

Secretary

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people?role=secretary

Rep Link

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people?role=rep_link

Lead Link

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people?role=lead_link

Facilitator

curl -H "X-Auth-Token: $API_KEY" https://api.glassfrog.com/api/v3/people?role=facilitator

Response Format

{
    "people": [{
        "id": 911230097,
        "name": "Monica Wolfson",
        "email": "monica@example.com",
        "external_id": null
    }, {
        "id": 516784585,
        "name": "Joyce Bilbrey",
        "email": "joyce@example.com",
        "external_id": null
    }
}

Attribute Notes

• external_id (optional): for client use for storing ids from systems outside of GlassFrog

Adding People (POST)

Create a New Member of the Organization

curl -H "X-Auth-Token: $API_KEY" -X POST -d '{"people":[{ "name":"Sally Benally", "email":"sally@example.com" }]}' https://api.glassfrog.com/api/v3/people

A successful POST returns status 200 with the newly created resource in the body:

{
    "people": [{
        "id": 657190835,
        "name": "Lawrence Copper",
        "email": "lawrence@example.com",
        "external_id": null
    }]
}

Emails Sent

Creating a Person through the API will email the new user with a welcome email and instructions for setting their password.

Permissions Notes

Only API_keys associated with accounts with admin permissions can add people to an organization.

Attributes

• abc name (required): full name of the person
• abc email (required): email of the person
• abc external_id (optional): id of the person from any external system

Updating People (PATCH/PUT)

Updating Name

curl -H "X-Auth-Token: $API_KEY" -X PATCH -d '[{ "op":"replace","path":"/people/0/name", "value":"Sally Martinez"}]' https://api.glassfrog.com/api/v3/people/$PERSON_ID

Updating Multiple Attributes

curl -H "X-Auth-Token: $API_KEY" -X PATCH -d '[{ "op":"replace","path":"/people/0/name", "value":"Sally Martinez"},{"op":"replace","path":"/people/0/email", "value":"sally.martinez@example.com"}]' https://api.glassfrog.com/api/v3/people/$PERSON_ID

Returns 204 No Content on success.

Removing People (DELETE)

Remove a Person

curl -H "X-Auth-Token: $API_KEY" -X DELETE https://api.glassfrog.com/api/v3/people/$PERSON_ID

returns 204 No Content on success.