User

List all users in your organization.

get/user

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/user
  • Auth
    HTTP bearer

Query parameters

organization_idstring required

Filter users by the ID of the organization.

emailstring

Filter users by their email address.

first_namestring

Filter users by their first name.

last_namestring

Filter users by their last name.

status'active' | 'inactive' | 'pending' | 'invited'

Filter users by their status. Multiple values can be provided, separated by commas.

idstring

Filter users by their ID. Multiple values can be provided, separated by commas.

type'machine' | 'person'

Filter users by user type.

offsetinteger

Number of items to skip. Defaults to 0.

limitinteger

Maximum number of items to return per page. Maximum is 200.

Response

The list of users matching the query.

Example response

{
  "results": [
    {
      "id": 123456,
      "email": "alex.mgr@crypto-inc.com",
      "first_name": "Alex",
      "last_name": "Doe",
      "organization_id": 1234,
      "status": "active",
      "avatar": "https://my-avatar-url.com",
      "type": "person",
      "provider": "cognito",
      "nrn": "organization=123",
      "send_invite": true,
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status