Skip to content
Platform Usage APIs
/
Team APIs
/
/Members API

Members API

Allows you to query and export a list of all members assigned to a Celonis Platform team.

Operations

List of all members

Request

Maximum number of members that will be received by page is 200.
The OAuth 2.0 scope to use is team.user-group-info:read.

Security
Authorization
Query
pageNumberinteger, (int32), >= 0

Page number to be retrieved. Starts with 0.

Default:0
Example:pageNumber=0
pageSizeinteger, (int32), [ 1 .. 200 ]

Limit of results per page

Default:200
Example:pageSize=200
includeInternalbooleanrequired

A boolean parameter to show internal or external members

Default:true
Example:includeInternal=true
curl -i -X GET \
  'https://developer.celonis.com/_mock/celonis-apis/team-api/openapi/openapi/api/external/members?pageNumber=0&pageSize=200&includeInternal=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of Members

Bodyapplication/json
contentArray of objects(MemberProfileExternalTransport)
pageNumberinteger, (int32)
pageSizeinteger, (int32)
totalCountinteger, (int64)
Response
{
  "content": [
    {
      "group": [
        {
          "name": "Sample Group",
          "teamRole": "ANALYST"
        }
      ],
      "inactivityPeriod": 14,
      "lastLogin": "12/10/2023, 6:49:07 AM UTC",
      "nameAndEmail": "Lorem Ipsum (email@example.com)",
      "status": "Active",
      "userId": "8161c24e-2b32-44eb-bedb-ede2267be989",
      "userRole": "MEMBER"
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "totalCount": 0
}