An organization object contains information about an organization. It contains relationships to users.
Finding
org_id
Some of our endpoints include a
org_id
in our path parameter. Thisorg_id
represents the organization we want to fetch and modify.The
org_id
should only contain two types of hashids, eitherorg
for organizations underpadlet.org
orwksp
for workspaces underpadlet.com
.You can find
org_id
using the/me
endpoint as stated in the get current user endpoint.
If you want the data of each user to be included with the organization object then make sure ?include=users
is added to the end of the GET request URL. eg: GET https://api.padlet.dev/v1/organizations/abcd1234ysdf57mg?include=users
An example of an organization object is displayed below.
{
"id": "org_abcd1234efgh5678",
"type": "organization",
"attributes": {
"name": "Acme Corporation",
"organizationType": "organization",
"role": "owner"
},
"relationships": {
"users": {
"data": [
{
"type": "user",
"id": "user_abcd1234efgh5678"
}
]
}
}
}
Organization object properties
Properties | Type | Description |
---|---|---|
id | string | Organization ID |
type | string | Always "organization" . |
attributes.name | string | Name of the organization |
attributes.organizationType | string | Type of organization. |
attributes.role | string | Role of the current user in the organization. |
relationships.users | object | List of user objects in the organization. Only contains type and id as per JSON:API specification. |