Skip to main content
GET
/
v1
/
users
Get Users
curl --request GET \
  --url https://app.untetherlabs.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "user",
      "name": "<string>",
      "email": "<string>",
      "status": "onboarding"
    }
  ],
  "cursor": "<string>"
}
Search for registered users in the Untether app.
Users are a superset of Providers, but providers are used for most platform operations. Users and providers share the same IDs, but not all users have an associated provider.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
type
enum<string>[]
Available options:
user,
bot
​
status
enum<string>[]
Available options:
onboarding,
active,
dismissed,
inactive
​
name
string

Case-insensitive partial matching name search string

Maximum string length: 50
​
pageSize
number
default:20
Required range: 1 <= x <= 200
​
cursor
string

Response

​
items
object[]
required
​
cursor
string