User

A user object contains information about a user. It contains relationships to different boards and organizations.

📘

Finding user_id

Some of our endpoints include a user_id in our path parameter. This user_id represents the user we want to fetch and modify.

You can find user_id of users in your organization by using the get user's boards in organization endpoint.

If you want the data of boards and organizations to be included with the user object then make sure ?include=boards,organizations is added to the end of the GET request URL. eg: GET https://api.padlet.dev/v1/me?include=boards,organizations

An example of a user object is displayed below.

{
  "id": "user_abcd1234efgh5678",
  "type": "user",
  "attributes": {
    "email": "[email protected]",
    "name": "Tony Stark",
    "username": "ironman",
    "displayName": "Tony",
    "avatar": "https://padlet.net/avatars/ironman.png",
    "bio": "Genius, billionaire, playboy, philanthropist. I am Iron Man."
  },
  "relationships": {
    "boards": {
      "data": [
        {
          "type": "board",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "organizations": {
      "data": [
        {
          "type": "organization",
          "id": "abcd1234efgh5678"
        }
      ]
    }
  }
}

User object properties