Users

Get organization members

Get a list of members for an organization.

GET/organizations/{organizationId}/users

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Query parameters

Response

200404

OK

Body

application/json

results*array of UserMembership

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/users', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "pending",
        "name": "text",
        "bio": "text",
        "activeSessions": 0,
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z",
        "emails": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[e-mail]",
            "verified": false,
            "passwordSet": false,
            "tokenSet": false,
            "createdAt": "2024-12-21T12:20:32.376Z",
            "updatedAt": "2024-12-21T12:20:32.376Z"
          }
        ],
        "defaultEmail": "text",
        "identities": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "avatarUrl": "text",
            "provider": "text",
            "createdAt": "2024-12-21T12:20:32.376Z",
            "updatedAt": "2024-12-21T12:20:32.376Z"
          }
        ],
        "avatarUrl": "text",
        "phoneNumber": "text",
        "phoneNumbers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "phoneNumber": "text",
            "verified": false,
            "primary": false,
            "createdAt": "2024-12-21T12:20:32.376Z",
            "updatedAt": "2024-12-21T12:20:32.376Z"
          }
        ],
        "locale": "text",
        "timezone": "text",
        "badges": [
          "messagebird:cx"
        ],
        "userFraudInformation": {
          "score": 0,
          "userId": "text"
        }
      },
      "status": "banned",
      "createdAt": "2024-12-21T12:20:32.376Z",
      "updatedAt": "2024-12-21T12:20:32.376Z",
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create organization member

Add a user to an organization. This can either be an existing user, or a new user that is invited to the platform.

POST/organizations/{organizationId}/users

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

CreateMembership (one of)

AddUserInviteUser

Response

201403404409422

Created

Body

application/json

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

403404409422

{
  "code": "text",
  "message": "text"
}

Get organization user

Get a single organization membership record.

GET/organizations/{organizationId}/users/{userId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

userId*string

The user ID

Response

200404

OK

Body

application/json

user*User

A user on the platform.

status*MembershipStatus (enum)

The status of user's membership on the organization.

bannedinvitedactive

createdAt*string (date-time)

When the membership was created.

updatedAt*string (date-time)

When the membership was last updated.

roleRefs*array of RoleReference

The list of roles to assign to the membership

teamRolesnullable array of TeamRole

The list of roles inherited from teams

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/users/{userId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 0,
    "createdAt": "2024-12-21T12:20:32.376Z",
    "updatedAt": "2024-12-21T12:20:32.376Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[e-mail]",
        "verified": false,
        "passwordSet": false,
        "tokenSet": false,
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "avatarUrl": "text",
    "phoneNumber": "text",
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "phoneNumber": "text",
        "verified": false,
        "primary": false,
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 0,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2024-12-21T12:20:32.376Z",
  "updatedAt": "2024-12-21T12:20:32.376Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "teamRoles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ]
}

Delete organization user

Remove a user from the organization

DELETE/organizations/{organizationId}/users/{userId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

userId*string

The user ID

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/users/{userId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Update organization user

Update the properties of the organization membership for the user.

PATCH/organizations/{organizationId}/users/{userId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

userId*string

The user ID

Body

application/json

roleRefsarray of RoleReference

THe list of roles to assign to the membership

Response

200403404422

OK

Body

application/json

user*User

A user on the platform.

status*MembershipStatus (enum)

The status of user's membership on the organization.

bannedinvitedactive

createdAt*string (date-time)

When the membership was created.

updatedAt*string (date-time)

When the membership was last updated.

roleRefs*array of RoleReference

The list of roles to assign to the membership

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/users/{userId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404422

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 0,
    "createdAt": "2024-12-21T12:20:32.376Z",
    "updatedAt": "2024-12-21T12:20:32.376Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[e-mail]",
        "verified": false,
        "passwordSet": false,
        "tokenSet": false,
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "avatarUrl": "text",
    "phoneNumber": "text",
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "phoneNumber": "text",
        "verified": false,
        "primary": false,
        "createdAt": "2024-12-21T12:20:32.376Z",
        "updatedAt": "2024-12-21T12:20:32.376Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 0,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2024-12-21T12:20:32.376Z",
  "updatedAt": "2024-12-21T12:20:32.376Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}