# Get Users

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Users"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/api/v1/users"}
  context={"endpoint"}
>
  
</MethodEndpoint>

Retrieve the properties of all user objects in your organization.

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

<ParamsDetails
  parameters={[{"description":"Includes deleted users in the response.","in":"query","name":"include_deleted","required":false,"schema":{"default":false,"description":"Includes deleted users in the response.","title":"Include Deleted","type":"boolean"}},{"description":"Includes external users in the response.","in":"query","name":"include_external","required":false,"schema":{"default":false,"description":"Includes external users in the response.","title":"Include External","type":"boolean"}},{"description":"The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.","in":"query","name":"limit","required":false,"schema":{"default":10,"description":"The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.","maximum":100,"title":"Limit","type":"integer"}},{"description":"Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.","in":"query","name":"before","required":false,"schema":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.","title":"Before"}},{"description":"Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.","in":"query","name":"after","required":false,"schema":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.","title":"After"}},{"description":"The number of the page you want to see.","in":"query","name":"page_number","required":false,"schema":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the page you want to see.","title":"Page Number"}},{"description":"The OData filter you want to use to in your query. It supports exact match and `AND` operations. For example, to filter for a metadata `category:news` and `published_date` greater than or equal to January 1 2025, here's what the URL could look like: 'url = \"https://api.cloud.deepset.ai/api/v1/workspaces/production/files?limit=10&filter=category eq 'news' and published_date ge '2025-01-01' \"'. OData filters only work with cursor-based pagination (leave the `page_number` field blank to enable it).To learn more about the OData filter syntax, see: [Querying Data](https://www.odata.org/getting-started/basic-tutorial/#queryData).","in":"query","name":"filter","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The OData filter you want to use to in your query. It supports exact match and `AND` operations. For example, to filter for a metadata `category:news` and `published_date` greater than or equal to January 1 2025, here's what the URL could look like: 'url = \"https://api.cloud.deepset.ai/api/v1/workspaces/production/files?limit=10&filter=category eq 'news' and published_date ge '2025-01-01' \"'. OData filters only work with cursor-based pagination (leave the `page_number` field blank to enable it).To learn more about the OData filter syntax, see: [Querying Data](https://www.odata.org/getting-started/basic-tutorial/#queryData).","title":"Filter"}}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"deleted":{"description":"Indicates if a user is deleted.","title":"Deleted","type":"boolean"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email of a user.","title":"Email"},"family_name":{"description":"Family name of a user.","title":"Family name","type":"string"},"given_name":{"description":"Given name of a user.","title":"Given name","type":"string"},"oauth_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Oauth ID from auth0","title":"Oauth ID"},"oauth_provider":{"description":"Oauth provider from auth0. For example: 'auth0', 'google-auth', 'github', and the like.","title":"Oauth Provider","type":"string"},"organization":{"description":"The deepset organization the user belongs to.","title":"Organization","properties":{"default_landing_page":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Default landing page for the organization.","title":"Default Landing Page"},"extra_dependencies":{"default":[],"description":"List of pinned PyPI packages to install alongside the pipeline runtime (e.g. [\"numpy==1.26.4\"]).","items":{"type":"string"},"title":"Extra Dependencies","type":"array"},"gpu_enabled":{"description":"Indicates whether GPU resources are enabled for this organization.","title":"GPU Enabled","type":"boolean"},"local_builder_enabled":{"description":"Indicates if the local builder feature is enabled.","title":"Local Builder Enabled","type":"boolean"},"max_workspaces":{"description":"Maximum number of workspaces a user can access.","title":"Max Workspaces","type":"integer"},"name":{"description":"Unique name of a deepset organization.","title":"Organization name","type":"string"},"organization_id":{"description":"Unique identifier of an organization.","format":"uuid","title":"Organization ID","type":"string"},"organization_type":{"description":"Type of the organization.","title":"Organization Type","enum":["FULL_DEEPSET_CLOUD","DEEPSET_STUDIO_WITH_LIMITS"],"type":"string"},"pricing_plan":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Pricing plan of an organization, between 0 and 3.","title":"Pricing plan"},"role":{"description":"Role of the user. This can be a custom role or one of the default roles.","title":"User Role","type":"string"},"workspaces":{"description":"Workspaces the user can access.","items":{"properties":{"name":{"description":"Name of the workspace.","title":"Workspace Name","type":"string"},"role":{"description":"Role of the user. This can be a custom role or one of the default roles.","title":"User Role","type":"string"},"role_id":{"description":"Unique identifier of the role.","format":"uuid","title":"Role ID","type":"string"}},"required":["name","role","role_id"],"title":"EntityRole","type":"object"},"title":"User Workspaces","type":"array"}},"required":["name","organization_id","role","workspaces","max_workspaces","organization_type","local_builder_enabled","gpu_enabled"],"type":"object"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"User-specific settings stored as JSON.","title":"User Settings"},"user_id":{"description":"Unique identifier of a user.","format":"uuid","title":"User ID","type":"string"},"userflow_signature":{"description":"Userflow signature.","title":"Userflow Signature","type":"string"}},"required":["given_name","family_name","user_id","oauth_id","oauth_provider","organization","deleted","userflow_signature"],"title":"User","type":"object"},"title":"Data","type":"array"},"has_more":{"description":"Indicates if there are more results to show.","title":"Has more results","type":"boolean"},"total":{"description":"The total number of results matching your query.","title":"Total number of results","type":"integer"}},"required":["data","has_more","total"],"title":"PaginatedResult[MeUser]","type":"object"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}},"description":"Validation Error"}}}
>
  
</StatusCodes>