Get Users

gethttps://app.untetherlabs.com/api/v1/users

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.

This endpoint is paginated. See Pagination for how to page through the results.

Request

curl -X GET 'https://app.untetherlabs.com/api/v1/users' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY'

Response 200

{
  "items": [
    {
      "type": "user",
      "name": "string",
      "email": "string",
      "status": "onboarding",
      "isAdmin": true
    }
  ],
  "cursor": "string"
}

Query parameters#

typeUserType[]· default ["user"]

user
bot

statusEmploymentStatus[]· default ["onboarding","active"]

onboarding
active
dismissed
unmanaged

namestring· max length 50

Case-insensitive partial matching name search string

pageSizenumber· default 20 · min 1 · max 200

cursorstring

Response 200#

itemsUser[]

Required

typeUserType

Required

user
bot

namestring

Required

emailstring

Required

statusEmploymentStatus

Required

onboarding
active
dismissed
unmanaged

isAdminboolean

Required

cursorstring

Errors#

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required