Users

Get organization members

get

Get a list of members for an organization.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

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

200

application/json

Responseall of

404

Resource not found

application/json

get

/organizations/{organizationId}/users

GET /organizations/{organizationId}/users HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "pending",
        "name": "text",
        "bio": "text",
        "activeSessions": 1,
        "createdAt": "2025-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z",
        "emails": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]",
            "verified": true,
            "passwordSet": true,
            "tokenSet": true,
            "createdAt": "2025-11-27T03:50:53.094Z",
            "updatedAt": "2025-11-27T03:50:53.094Z"
          }
        ],
        "defaultEmail": "text",
        "identities": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "avatarUrl": "text",
            "provider": "text",
            "createdAt": "2025-11-27T03:50:53.094Z",
            "updatedAt": "2025-11-27T03:50:53.094Z"
          }
        ],
        "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-11-27T03:50:53.094Z",
            "updatedAt": "2025-11-27T03:50:53.094Z"
          }
        ],
        "locale": "text",
        "timezone": "text",
        "badges": [
          "messagebird:cx"
        ],
        "userFraudInformation": {
          "score": 1,
          "userId": "text"
        }
      },
      "status": "banned",
      "createdAt": "2025-11-27T03:50:53.094Z",
      "updatedAt": "2025-11-27T03:50:53.094Z",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "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

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Body

one ofOptional

Responses

201

Created

application/json

403

The e-mail domain not allowed to register with

application/json

404

Resource not found

application/json

409

The resource already exists

application/json

422

Request validation failed

application/json

post

/organizations/{organizationId}/users

POST /organizations/{organizationId}/users HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "attributes": {
    "roles": [
      "managed:organization_admin",
      "managed:organization_finance_admin"
    ]
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get organization user

get

Get a single organization membership record.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

userIdstringRequired

The user ID

Query parameters

previewbooleanOptional

Responses

200

application/json

404

Resource not found

application/json

get

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

GET /organizations/{organizationId}/users/{userId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 1,
    "createdAt": "2025-11-27T03:50:53.094Z",
    "updatedAt": "2025-11-27T03:50:53.094Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "verified": true,
        "passwordSet": true,
        "tokenSet": true,
        "createdAt": "2025-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2025-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "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-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 1,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2025-11-27T03:50:53.094Z",
  "updatedAt": "2025-11-27T03:50:53.094Z",
  "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"
          ]
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Delete organization user

delete

Remove a user from the organization

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

userIdstringRequired

The user ID

Query parameters

previewbooleanOptional

Responses

204

404

Resource not found

application/json

delete

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

DELETE /organizations/{organizationId}/users/{userId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Update organization user

patch

Update the properties of the organization membership for the user.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

userIdstringRequired

The user ID

Query parameters

previewbooleanOptional

Body

roleIdsstring · uuid[] | nullableOptionalDeprecated

Roles to assign to the user (legacy, use attributes instead)

roleTreatmentstring | nullableOptional

Used to allow removing the legacy roles for the user

Responses

200

application/json

403

Forbidden operation

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

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

PATCH /organizations/{organizationId}/users/{userId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "attributes": {
    "roles": [
      "managed:organization_admin",
      "managed:organization_finance_admin"
    ]
  },
  "roleTreatment": "text"
}

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "name": "text",
    "bio": "text",
    "activeSessions": 1,
    "createdAt": "2025-11-27T03:50:53.094Z",
    "updatedAt": "2025-11-27T03:50:53.094Z",
    "emails": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "verified": true,
        "passwordSet": true,
        "tokenSet": true,
        "createdAt": "2025-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "defaultEmail": "text",
    "identities": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "avatarUrl": "text",
        "provider": "text",
        "createdAt": "2025-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "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-11-27T03:50:53.094Z",
        "updatedAt": "2025-11-27T03:50:53.094Z"
      }
    ],
    "locale": "text",
    "timezone": "text",
    "badges": [
      "messagebird:cx"
    ],
    "userFraudInformation": {
      "score": 1,
      "userId": "text"
    }
  },
  "status": "banned",
  "createdAt": "2025-11-27T03:50:53.094Z",
  "updatedAt": "2025-11-27T03:50:53.094Z",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Last updated 1 month ago

Was this helpful?