Skip to content

Latest commit

 

History

History
152 lines (133 loc) · 3.55 KB

people.md

File metadata and controls

152 lines (133 loc) · 3.55 KB
Raw

People

Get people

  • GET v3/people will return all people.
[
    {
        "id":12009183,
        "first_name":"Chris",
        "last_name":"Wagley",
        "title":"Manager",
        "email":"chris@email.com",
        "role":{
            "id":903912753
        },
        "groups":[
            33838231,
            33838232
        ],
        "timezone":8,
        "initials":"N",
        "image_url":null,
        "profile_color":"#781f1f",
        "language":"en",
        "suspended":false,
        "send_invite":true,
        "last_active":"2016-09-19T06:17:22+00:00",
        "created_at":"2016-09-16T10:39:25+00:00",
        "updated_at":"2016-09-16T10:39:25+00:00",
        "projects":[
            23423233,
            23423234
        ]
    },
    {
        "id":11679192,
        "first_name":"Stella",
        "last_name":"Altois",
        "title":"Manager",
        "email":"stella@email.com",
        "role":{
            "id":90391275
        },
        "groups":[
            33838231,
            33838232
        ],
        "timezone":10,
        "initials":"C",
        "image_url":null,
        "profile_color":"#781f1f",
        "language":"en",
        "suspended":false,
        "send_invite":true,
        "last_active":"2016-09-19T06:17:22+00:00",
        "created_at":"2016-09-16T10:39:25+00:00",
        "updated_at":"2016-09-16T10:39:25+00:00",
        "projects":[
            23423233,
            23423234
        ]
    }
]

Get person

  • GET v3/people/11679192 will return the specified person.
{
    "id":11679192,
    "first_name":"Stella",
    "last_name":"Altois",
    "title":"Manager",
    "email":"stella@email.com",
    "role":{
        "id":90391275
    },
    "groups":[
        33838231,
        33720182
    ],
    "timezone":10,
    "initials":"C",
    "image_url":null,
    "profile_color":"#781f1f",
    "language":"en",
    "suspended":false,
    "send_invite":true,
    "last_active":"2016-09-19T06:17:22+00:00",
    "created_at":"2016-09-16T10:39:25+00:00",
    "updated_at":"2016-09-16T10:39:25+00:00",
    "projects":[
        23423233,
        23423234
    ]
}

Create person

  • POST v3/people will add a new person to the account.
{
    "first_name":"Stella",
    "last_name":"Altois",
    "email":"stella.altois@email.com",
    "role":"90391275",
    "language":"en"
}

Language example en, fr. You can get supported languages from the languages API. You can get the group from the groups API.

Update person

  • PUT v3/people/11679192 will update the person.
{
    "first_name":"Stella",
    "last_name":"Altois",
    "email":"stella.altois@email.com",
    "role":"90391275",
    "language":"en"
}

200 OK will be returned along with the JSON of the person (Get person) if the record is updated. You can get supported languages from the languages API. 403 Forbidden will be returned in case of invalid access.

Delete person

  • DELETE v3/people/11679192 will delete the person specified.

204 No Content will be returned if the record is deleted. 403 Forbidden will be returned in case of invalid access.