Skip to content
SkillPouchSkillPouch Docs

Search users (email, name, id)

GET
/v1/admin/users
curl --request GET \
  --url 'https://app.skillpouch.net/v1/admin/users?limit=50'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 200 characters
cursor
string
<= 200 characters
limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
ok
required
boolean
data
required
object
items
required
Array<object>
object
id
required
string
email
required
string
name
required
string
role
required
string
Allowed values: user admin
suspended_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
storage_account_id
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
entitlements
required
Any of:
object
plan_slug
required
string
plan_name
required
string
source
required
string
Allowed values: default subscription grant override
pouch_limit
required
integer
>= -9007199254740991 <= 9007199254740991
storage_bytes
required
integer
>= -9007199254740991 <= 9007199254740991
used_bytes
required
integer
>= -9007199254740991 <= 9007199254740991
device_count
required
integer
>= -9007199254740991 <= 9007199254740991
pouch_count
required
integer
>= -9007199254740991 <= 9007199254740991
meta
required
object
request_id
required
string
next_cursor
string | null

Example 

{
  "ok": true,
  "data": {
    "items": [
      {
        "role": "user",
        "entitlements": {
          "source": "default"
        }
      }
    ]
  }
}