Users

Last updated 1 year ago

Was this helpful?

Get organization members

Get a list of members for an organization.

get

/organizations/{organizationId}/users

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

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

Limits the number of results to return

pageTokenstring

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

reverseboolean

Order in which to retrieve the results

previewboolean

searchTermstring

Search term used to filter organizations by name

userIdsstring · uuid[]

List of user IDs.

emailstring · email

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

one of

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":[null]}],"roleIds":[null]}'

201

403

404

409

422

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Created

Get organization user

Get a single organization membership record.

get

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

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

Delete organization user

Remove a user from the organization

delete

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

Update organization user

Update the properties of the organization membership for the user.

patch

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

userIdstringrequired

The user ID

Query parameters

previewboolean

Body

roleRefsRoleReference[]

THe list of roles to assign to the membership

roleIdsstring · uuid[]Deprecated

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":[null]}],"roleIds":[null]}'

200

403

404

422

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