Users

Last updated 1 year ago

Was this helpful?

Get organization user

get

Get a single organization membership record.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/users/{userId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 1,
    "createdAt": "2025-03-28T18:48:17.246Z",
    "updatedAt": "2025-03-28T18:48:17.246Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "name@gmail.com",
        "verified": true,
        "passwordSet": true,
        "tokenSet": true,
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "avatarUrl": "text",
    "phoneNumber": "text",
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "phoneNumber": "text",
        "verified": true,
        "primary": true,
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 1,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2025-03-28T18:48:17.246Z",
  "updatedAt": "2025-03-28T18:48:17.246Z",
  "roleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "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

delete

Remove a user from the organization

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/users/{userId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Get organization members

get

Get a list of members for an organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstringoptional

Pagination token that keeps of track of the current position in the list

reverseboolean · default: falseoptional

Order in which to retrieve the results

previewbooleanoptional

searchTermstringoptional

Search term used to filter organizations by name

userIdsstring · uuid[]optional

List of user IDs.

emailstring · emailoptional

If set, returns the user that is registered with this email address. Only does exact matching.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/users' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "pending",
        "name": "text",
        "bio": "text",
        "activeSessions": 1,
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z",
        "emails": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "name@gmail.com",
            "verified": true,
            "passwordSet": true,
            "tokenSet": true,
            "createdAt": "2025-03-28T18:48:17.246Z",
            "updatedAt": "2025-03-28T18:48:17.246Z"
          }
        ],
        "defaultEmail": "text",
        "identities": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "avatarUrl": "text",
            "provider": "text",
            "createdAt": "2025-03-28T18:48:17.246Z",
            "updatedAt": "2025-03-28T18:48:17.246Z"
          }
        ],
        "avatarUrl": "text",
        "phoneNumber": "text",
        "phoneNumbers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "phoneNumber": "text",
            "verified": true,
            "primary": true,
            "createdAt": "2025-03-28T18:48:17.246Z",
            "updatedAt": "2025-03-28T18:48:17.246Z"
          }
        ],
        "locale": "text",
        "timezone": "text",
        "badges": [
          "messagebird:cx"
        ],
        "userFraudInformation": {
          "score": 1,
          "userId": "text"
        }
      },
      "status": "banned",
      "createdAt": "2025-03-28T18:48:17.246Z",
      "updatedAt": "2025-03-28T18:48:17.246Z",
      "roleIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create organization member

post

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

one ofoptional

Add an existing user to the organization

Invite a new user to the organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/users' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "roleIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

201

403

404

409

422

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Created

Update organization user

patch

Update the properties of the organization membership for the user.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewbooleanoptional

Body

roleRefsobject[] · min: 1optional

THe list of roles to assign to the membership

roleIdsstring · uuid[] · min: 1 · max: 5optionalDeprecated

Roles to assign to the user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/users/{userId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "roleIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

422

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 1,
    "createdAt": "2025-03-28T18:48:17.246Z",
    "updatedAt": "2025-03-28T18:48:17.246Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "name@gmail.com",
        "verified": true,
        "passwordSet": true,
        "tokenSet": true,
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "avatarUrl": "text",
    "phoneNumber": "text",
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "phoneNumber": "text",
        "verified": true,
        "primary": true,
        "createdAt": "2025-03-28T18:48:17.246Z",
        "updatedAt": "2025-03-28T18:48:17.246Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 1,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2025-03-28T18:48:17.246Z",
  "updatedAt": "2025-03-28T18:48:17.246Z",
  "roleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Get organization user

Delete organization user

Get organization members

Create organization member

Show AddUser

Show InviteUser

Update organization user

Show child attributes