latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

Organizations

Get organization members

This endpoint returns a organization members / stakeholders

get/organizations/{id}/members

Path parameters

idstring required

Headers

x-icr-api-versionstring

API version

Response

isStakeAcceptedboolean required

Whether the stakeholder has accepted the stake or not

organizationIdstring required

The ID of the organization

permissionsstring[] required

The permissions of the stakeholder

rolesstring[] required

The roles of the stakeholder

createdAtstring date-time required

The date and time the stakeholder was created

updatedAtstring date-time required

The date and time the stakeholder was last updated

Example response

[
  {
    "isStakeAccepted": true,
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "permissions": [
      "VIEW",
      "WRITE",
      "ADMIN"
    ],
    "roles": [
      {}
    ],
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "user": {
      "email": "john.doe@example.com",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "profiles": {
        "countryCode": "US",
        "fullName": "John Doe",
        "profilePicture": "https://example.com/profile.jpg",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z",
        "roles": "user",
        "gender": "male",
        "phoneNumber": "+1 555-555-5555"
      }
    }
  }
]