Skip to main content
GET
/
core
/
v3
/
entity-groups
List entity groups
curl --request GET \
  --url https://api-{region}.sesametime.com/core/v3/entity-groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "groupId": "<string>",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "showGroup": true,
      "costCenter": true,
      "employeesCount": 123
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.sesametime.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
entityGroupId
string<uuid>

finds an entity group by entityGroupId

​
employeeId
string<uuid>

finds entity groups by employeeId

​
name[contains]
string
default:""

finds by name, can be exact name without [contains]

​
parentId
string<uuid>

if it is a subgroup you can find it by parentId

​
limit
integer

Limit assignations

​
page
integer

Request a specific page

Response

200 - application/json

Array of objects

​
data
object[]
​
meta
object