{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Users"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"users","__idx":0},"children":["Users"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Beta"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Users API is in Beta. Additive changes are normal, and breaking changes"," ","may be made with notice while the resource incorporates customer feedback. See"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/versioning"},"children":["Versioning and compatibility"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints list the team members of the business linked to your API"," ","Access Token. Both require the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["users:read"]}," scope."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"two-kinds-of-status","__idx":1},"children":["Two kinds of status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every user carries two independent statuses. Read them together - a user can be"," ","an active member of your business while their Rho account is blocked."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it tells you"},"children":["What it tells you"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Where the user sits in your business: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invited"]}," (invite sent, not yet accepted), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}," (accepted), or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removed"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The state of the user's Rho account: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blocked"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-users","__idx":2},"children":["List users"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/users"]}," returns the users on your business, newest first."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/users?membership_status=active&page_size=20\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status"]}," filters by membership. Leave it out and removed members are"," ","excluded - pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status=removed"]}," to see them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role_name"]}," filters by role, including custom roles you have defined. Role names"," ","are unique within a business."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," returns the single user on your business with that email, or an empty"," ","list if nobody matches. It combines with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status"]}," rather than"," ","overriding it, so a user you have removed also returns an empty list unless you"," ","pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status=removed"]}," alongside it. To look someone up regardless of"," ","membership status, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/users/{id}"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_by"]}," accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order"]}," can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asc"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]}," and defaults to"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]}," can be from 1 to 100 and defaults to 20 - follow the cursor"," ","as described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/pagination"},"children":["Pagination"]}," until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_page_token"]}," is"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"users\": [\n    {\n      \"id\": \"40000000-0000-4000-8000-000000000002\",\n      \"first_name\": \"Grace\",\n      \"last_name\": \"Hopper\",\n      \"email\": \"grace.hopper@example.com\",\n      \"phone_number\": \"+15551000002\",\n      \"membership_status\": \"active\",\n      \"user_status\": \"blocked\",\n      \"role_name\": \"Admin\"\n    }\n  ],\n  \"page\": {\"next_page_token\": null}\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_status"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role_name"]}," are always"," ","present. A name, email, or phone number Rho does not hold is omitted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-a-user","__idx":3},"children":["Get a user"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/users/{id}"]}," returns one user by their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," - the same identifier"," ","other resources use to reference a person. Use it to refresh a single user"," ","without paging the whole list."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/users/40000000-0000-4000-8000-000000000002\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"40000000-0000-4000-8000-000000000002\",\n  \"first_name\": \"Grace\",\n  \"last_name\": \"Hopper\",\n  \"email\": \"grace.hopper@example.com\",\n  \"phone_number\": \"+15551000002\",\n  \"membership_status\": \"active\",\n  \"user_status\": \"blocked\",\n  \"role_name\": \"Admin\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Users removed from your business are still returned here, with a"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["membership_status"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["removed"]},". A user who was never on your business returns"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference","__idx":4},"children":["Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/v1/openapi/users"},"children":["Rho API v1 reference"]}," for all fields and"," ","parameters."]}]},"headings":[{"value":"Users","id":"users","depth":1},{"value":"Two kinds of status","id":"two-kinds-of-status","depth":2},{"value":"List users","id":"list-users","depth":2},{"value":"Get a user","id":"get-a-user","depth":2},{"value":"Reference","id":"reference","depth":2}],"frontmatter":{"seo":{"title":"Users"}},"lastModified":"2026-10-23T10:00:23.883Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/v1/users","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}