People

• Get people
• Get person
• Create person
• Update person
• Delete person

Get people

GET v3/people returns all people in the account.

[
  {
    "id": 12009183,
    "first_name": "Chris",
    "last_name": "Wagley",
    "title": "Manager",
    "email": "chris@email.com",
    "role": {
      "id": 903912753
    },
    "language": "en",
    "suspended": false
  },
  {
    "id": 11679192,
    "first_name": "Stella",
    "last_name": "Altois",
    "title": "Manager",
    "email": "stella@email.com",
    "role": {
      "id": 90391275
    },
    "language": "en",
    "suspended": false
  }
]

Get person

GET v3/people/11679192 returns the specified person.

{
  "id": 11679192,
  "first_name": "Stella",
  "last_name": "Altois",
  "title": "Manager",
  "email": "stella@email.com",
  "role": {
    "id": 90391275
  },
  "groups": [
    33838231,
    33720182
  ],
  "language": "en",
  "suspended": false
}

Create person

POST v3/people adds a new person to the account.

Request Body

{
  "first_name": "Stella",
  "last_name": "Altois",
  "email": "stella.altois@email.com",
  "role": "90391275",
  "language": "en"
}

Supported language codes can be retrieved from the Languages API. Group IDs can be retrieved from the Groups API.

201 Created is returned along with the created person's details.

Update person

PUT v3/people/11679192 updates an existing person.

Request Body

{
  "first_name": "Stella",
  "last_name": "Altois",
  "email": "stella.altois@email.com",
  "role": "90391275",
  "language": "en"
}

200 OK is returned along with the updated person JSON if the record is updated successfully.

Supported language codes can be retrieved from the Languages API.

403 Forbidden is returned if access is denied.

Delete person

DELETE v3/people/11679192 deletes the specified person.

Deleting a person removes their access to the account and associated permissions.

200 OK is returned if the person is deleted successfully. 403 Forbidden is returned if access is denied.