---
updatedAt: 2026-09-11T07:28:51.000Z
agentTools:
projectIndex: https://docs.padlet.dev/llms.txt
---
# Get user's information in organization
Get a user's boards within an organization. Requires admin access.
Gets information about a specific user within an organization by their user ID, optionally including the boards data. Returns [user object](https://docs.padlet.dev/reference/user-object).
You can find the user ID of a user in your organization by using the [get organization](https://docs.padlet.dev/reference/get-organization-by-id) endpoint.
You will only be able to view the boards within the organization that you have access to. You will also be able to use the [get board by id](https://docs.padlet.dev/reference/get-board-by-id) endpoint to get more information about them.
> 📘 API key
>
> You will need to include your API key found here.
>
> Please include the key in your header. `{"X-API-KEY": }`
To include the data of the user's boards in the organization, please ensure `?include=boards` is added to the end of the url.
### Authorization required
This endpoint requires admin access to the organization. You must be an admin or owner of the organization to access its data.
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "Endpoints",
"version": "1.0",
"description": "Read and create posts.",
"contact": {
"name": "Padlet Engineer",
"email": "engine@wallwisher.com",
"url": "https://legal.padlet.com"
},
"license": {
"url": "https://legal.padlet.com",
"name": "CPadlet"
},
"termsOfService": "https://legal.padlet.com"
},
"servers": [
{
"url": "https://api.padlet.dev/v1",
"description": "V1."
}
],
"paths": {
"/organizations/{org_id}/users/{user_id}": {
"parameters": [
{
"name": "org_id",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/id"
},
"description": "ID of the organization"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/id"
},
"description": "ID of the user"
}
],
"get": {
"summary": "Get user's information in organization",
"responses": {
"200": {
"$ref": "#/components/responses/userBoardsInOrg"
},
"403": {
"$ref": "#/components/responses/403-forbidden"
},
"404": {
"$ref": "#/components/responses/404-not-found"
}
},
"description": "Get a user's boards within an organization. Requires admin access.",
"parameters": [
{
"name": "include",
"in": "query",
"schema": {
"type": "string",
"example": "boards",
"default": "boards"
},
"description": "Set to 'boards' to include user's boards in response"
}
],
"operationId": "get-user-info-in-org",
"tags": [
"Organization"
],
"security": [
{
"apiKey": []
}
],
"x-internal": false
}
}
},
"components": {
"schemas": {
"id": {
"title": "Id",
"type": "string",
"minLength": 16,
"x-internal": false,
"example": "abcd1234efgh5678x",
"description": "ID of the object",
"maxLength": 22
},
"base_attributes_read": {
"title": "Base Attributes",
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"x-internal": false
},
"board_read": {
"title": "Board",
"type": "object",
"x-internal": false,
"x-examples": {},
"properties": {
"id": {
"type": "string",
"description": "ID of board."
},
"type": {
"type": "string",
"enum": [
"board"
]
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/board_attributes_read"
},
{
"$ref": "#/components/schemas/base_attributes_read"
}
]
}
}
},
"board_attributes_read": {
"title": "Board Attributes",
"type": "object",
"x-internal": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"builder": {
"$ref": "#/components/schemas/user_attributes"
},
"iconUrl": {
"type": "string"
},
"domainName": {
"type": "string",
"format": "uri"
},
"settings": {
"$ref": "#/components/schemas/board_settings"
},
"webUrl": {
"$ref": "#/components/schemas/board_weburl"
},
"customFields": {
"type": "object",
"description": "Custom field definitions configured for this board. Contains field IDs as keys and field configuration as values.",
"example": {}
}
}
},
"board_settings": {
"title": "Board Settings",
"type": "object",
"properties": {
"font": {
"type": "number",
"enum": [
1,
2,
3,
4
],
"description": "Font ID for a board:\n- 1 serif font\n- 2 sans serif font\n- 3 cursive font\n- 4 monospaced font"
},
"colorScheme": {
"type": "string",
"enum": [
"dark",
"light"
],
"default": "light"
}
},
"x-internal": false
},
"user_attributes": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"shortName": {
"type": "string"
},
"fullName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
},
"x-internal": false,
"example": {
"username": "j",
"shortName": "Jerry",
"fullName": "Jerry Seinfeld",
"avatarUrl": "http://example.com"
},
"title": "User Attributes"
},
"board_weburl": {
"title": "board_weburl",
"type": "object",
"properties": {
"live": {
"type": "string",
"example": "https://padlet.dev/api1/my-shiny-padlet-gqcilo8gv9qj5snz"
},
"qrCode": {
"type": "string",
"example": "https://cdn.padlet.dev/padlets/gqcilo8gv9qj5snz/qr_code.png"
},
"slideshow": {
"type": "string",
"example": "https://padlet.dev/api1/my-shiny-padlet-gqcilo8gv9qj5snz/slideshow"
},
"slideshowQrCode": {
"type": "string",
"example": "https://cdn.padlet.dev/padlets/gqcilo8gv9qj5snz/slideshow_qr_code.png"
}
}
},
"user_read": {
"title": "User",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of user."
},
"type": {
"type": "string",
"enum": [
"user"
]
},
"attributes": {
"title": "User Attributes",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"displayName": {
"type": "string"
},
"avatar": {
"type": "string",
"format": "uri"
},
"bio": {
"type": "string"
}
}
}
}
},
"user_read_relationships_just_boards": {
"title": "User Relationships",
"type": "object",
"properties": {
"relationships": {
"title": "has many boards",
"type": "object",
"properties": {
"boards": {
"$ref": "#/components/schemas/has_many_boards"
}
}
}
}
},
"has_many_boards": {
"title": "board",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"type": {
"type": "string",
"enum": [
"board"
]
}
}
}
}
}
}
},
"responses": {
"404-not-found": {
"description": "Object not found",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "404"
},
"title": {
"type": "string",
"example": "Record not found"
},
"detail": {
"type": "string",
"example": "Record not found"
},
"code": {
"type": "string",
"example": "NOT_FOUND"
}
}
}
}
}
},
"example": {
"errors": [
{
"status": "404",
"title": "Record not found",
"detail": "Record not found",
"code": "NOT_FOUND"
}
]
}
}
}
},
"userBoardsInOrg": {
"description": "Returns resource object for the user with their boards in the organization",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/user_read"
},
{
"$ref": "#/components/schemas/user_read_relationships_just_boards"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/board_read"
}
}
}
}
}
}
},
"403-forbidden": {
"description": "Not authorized to access this resource",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "403"
},
"title": {
"type": "string",
"example": "Not admin"
},
"detail": {
"type": "string",
"example": "You must be an admin or owner of this organization."
},
"code": {
"type": "string",
"example": "NOT_ADMIN"
}
}
}
}
}
}
}
}
}
},
"securitySchemes": {
"apiKey": {
"name": "X-Api-Key",
"type": "apiKey",
"in": "header",
"description": ""
}
}
},
"x-internal": false,
"tags": [
{
"name": "Organization",
"description": "Operations related to organizations."
}
]
}
```