---
id: user-list
title: "List users"
description: "List all users in your organization."
sidebar_label: "List users"
hide_title: true
hide_table_of_contents: true
api: eJzdWOtv2zYQ/1cIfmoBxXFe3WZgwLKm3TKsQZEmaIEkCM7S2WZLkSpJuXEN/e/DkZItWbLjpu4G7Iutx+nudy/eY84TtLERmRNa8QH/W1jHQEqWWzSWCcVmOjdMmzEo8RWIqscj7mBs+eCGX1s0/C7iOkPjX54nfMDp24EU1vGIZ2AgRYeG6OdckJDPOZoZj7iCFPmA15nfi4RH3MYTTIEP5tzNMiKxzgg15kXEDX7OhcGED5zJMVqB/1pIh6YEP5wxN0F2fsb0yF+taoEPkGaS+B8cHvEi6oaHKQi5LagRSLsNKmGY58sgSQxa24QDEh966dj8FptZ5vSeUHEv1ulaiCNhrLv3N7vH6ZkzYt4EeSrxYS0iCT8OEPHuwHOmcS0c68DldgOWiKPKUwppiJ2YEmyhFpcZqiRQCTUVDhN+91TwAUmPvcmlE5lENgWZo2UxKDZElhk9FQkmEbNIqeMwoW9jnaZge7eqGSYeX7QAuk777XPqGxQ5P9uNEgeHR8cnL6Jffv7pxcnxWhU85m3cl0I8ESo4zVitnuIpumAkYBVryXIdSD0aWXRdMIVyOEbDSfIIcun4oP84ros8HaKh00s4TC1zmtlPIuuxs8DEP+k3sqC/NiFFKraFdtKPeAoPIiWTHva3QPomUDPVRmzQ5UaxDA3LYIw9VtEKyw77TfQn/eIu4hbj3Ag38wVjiGDQnOZuwgc3d/TaoM20smhJicN+n/6aaK4myKj8EI7g1BQchcXYlwFvGZIba+VQOWIAWSZF7CvD/kfy8WDeNpUefsSYjLi0xg3PYBwi0KAln1A5zAwVRCcCxpJiMG98twiW4JnWV+X7TuWsA+OqqhbYsy9CJfpLj70RqjKvN27LzWkgCBEYhLeEtP2JElNUrnKpEThF79QYpOxyaltuPaKKYmmwpYHBGKCY9cHzmOH9qaaMz9CyRDfqYL0ErbYYLWuLZE1KrJp+2U1QZDWiN5xkRQWn03Oh6K9waJ1lWzQCdV07JS3L9mPiVC4lDEleaKlaJb5myu5cgy0lNYv1quSi7adOcXWiDn+0nNhwUBFVzcC6zHK5bbn423qDjR6tSjWHKTgw3TDCu6c7buJcZgf7++lsL7Day42sIiew6RJLb9bpXta+aFFhN6q5qJS8bAbWKZq7CSpXHr1V5/Co5hWoWI+VcJrqGqSSIK23SUVbhFOjE87F5cX2MVyPw1/DBMEtquQ+BEJbwvsJugm1FpoRHQPFAml5LDjdJXmotURQ9QK9olqZPCk6SMBBt2rV2zX6LY7YBdc5/4QzPuC+t+P+xHbCec3p28uyDLff0AxZf1tE/PjDhzaql1KgcgyN0YYtqjpLciRLCDUFKRImVJY7pg1LhbVU6JYT5c5qeMj6lzqhhPZ4KM7RWhhju1bUqB+vGX9eXb2tTpVYJ8gMZgYtxXzZjtgMYzESMYvr9niGvXEvYsf9Pv0c0M8R/Rw/b9ScY9+dxU0si1htQjllZeruGYSEkqSU5XG5CTgWg8OxNuIr2oANzRQNG4GQuVmZt4aQ3JMR0TqK/GC2LUAMjcBRxCZ5CmqJpEZVRWgA58+k0hq3/HdI2GUQesvpwbWiI8RDTm550zh1al4sPfo4yCQRdAmSJehASMtgqHO3hNWUQ/lVmoJ9AWo35UibFBPmrascCIXJIqTrEVwUIUNOujLkXTD/aoYIlfg4V2N/hFibI9PKgzt9e86sSPB/lhq2bogyGE4oNU76h/Rz9HxljvjPsoKUNQrkfSC6Dyb71/LjvBTPytB5RTQhU+iJiJFdK5iC8EWylTCdn//Q1DlVLFf4kGFMW4Kgko7j3BhMeuytRLDInJkxGINQTIKjslVUaZOim2jaOY4xbBtpTuT7VIaoKfBahM1jbmStMYJM9KhVyCQ4StXQG9WGz3eUHSGo6yPoQn1iVI3T/jT0RDwqL15rk4LjA/7X+ytOQIUaafqc8ARLHfT6vT5fls6LGhzKY988aetS8OlazvF+QeuH2lXTz5cJv/UaN+ji8MHtZxKEb9i8oealKW98RadEn2jr6H4+H4LFayOLgh6HNQMZOBGWYmrNiqCO7tllecA8Z9+2sO3EG7qU9hI59C0D7tc124Pbclm7AUo1je4UQHMLu0F6YwbeKYTG3nUDgvrgvVMA37873YB6sSLeKeTv25JugLvLEF/Zd26QWq5hnyh3+33mpkSv9mZPBPF9q8pNYV9uWJe47ujGiDCO3tAieoLgR+Gbarg6jWPM6l+1OjXisqhyf7y64hGHZilaKT2ee7VQU7Ma7/k8UFzpT6iKgi+8Sve8uCuK4h+oU6Sl
sidebar_class_name: "get api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List users"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/user"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List all users in your organization.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"organization_id","schema":{"type":"string"},"required":true,"description":"Filter users by the ID of the organization.","example":"123"},{"in":"query","name":"email","schema":{"type":"string"},"required":false,"description":"Filter users by their email address.","example":"alex.mgr@crypto-inc.com"},{"in":"query","name":"first_name","schema":{"type":"string"},"required":false,"description":"Filter users by their first name.","example":"Alex"},{"in":"query","name":"last_name","schema":{"type":"string"},"required":false,"description":"Filter users by their last name.","example":"Doe"},{"in":"query","name":"status","schema":{"type":"string","enum":["active","inactive","pending","invited"]},"required":false,"description":"Filter users by their status. Multiple values can be provided, separated by commas.\n","example":"active,inactive"},{"in":"query","name":"id","schema":{"type":"string"},"required":false,"description":"Filter users by their ID. Multiple values can be provided, separated by commas.\n","example":"123456,987654"},{"in":"query","name":"type","schema":{"type":"string","enum":["machine","person"]},"required":false,"description":"Filter users by user type.\n","example":"person"},{"in":"query","name":"offset","schema":{"type":"integer","default":0},"required":false,"description":"Number of items to skip. Defaults to 0.","example":0},{"in":"query","name":"limit","schema":{"type":"integer","default":50,"maximum":200},"required":false,"description":"Maximum number of items to return per page. Maximum is 200.","example":50}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The list of users matching the query.","content":{"application/json":{"schema":{"type":"object","required":["paging","results"],"properties":{"paging":{"required":["offset","limit"],"properties":{"offset":{"description":"The start of the paging window. Minimum is 0.","type":"integer","minimum":0},"limit":{"description":"Maximum number of elements to retrieve per call. Maximum is 200.","type":"integer","maximum":200}}},"results":{"type":"array","items":{"type":"object","required":["id","nrn","email","first_name","last_name","organization_id"],"properties":{"id":{"type":"integer","description":"The ID of the user.","example":123456},"email":{"description":"The email of the user.","type":"string","example":"alex.mgr@crypto-inc.com"},"first_name":{"description":"The first name of the user.","type":"string","nullable":true,"example":"Alex"},"last_name":{"description":"The last name of the user.","type":"string","example":"Doe","nullable":true},"organization_id":{"description":"The organization ID of the user.","type":"integer","example":1234},"status":{"description":"The status of the user.","enum":["active","inactive","pending","invited"],"type":"string","example":"active"},"avatar":{"description":"The avatar of the user.","type":"string","nullable":true,"example":"https://my-avatar-url.com"},"type":{"description":"The type of the user.","enum":["person","machine"],"type":"string","example":"person"},"provider":{"description":"The authentication provider of the user.","type":"string","enum":["cognito","saml"],"nullable":true,"example":"cognito"},"nrn":{"description":"The NRN of the user.","type":"string","example":"organization=123"},"send_invite":{"description":"Whether to send an invite email to the user.","type":"boolean","default":true,"example":true},"metadata":{"description":"The metadata of the user.","type":"object","example":{"key":"value"}}},"title":"userResponse"}}},"title":"userListResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>