Skip to main content
GET
/
users
List all users
curl --request GET \
  --url https://api-joy.joyfill.io/v1/users
"{\n  \"data\": [\"Object\", \"Object\", \"etc.\"]\n}"

Headers

Authorization
string

Supports both API Key and User Access Token authorization. See https://joyfill.mintlify.app/api/authentication

Query Parameters

limit
integer
default:25
required

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25.

page
integer
default:1
required

An integer for use with pagination. For instance, if limit is set to 25 and you set page to 2 then results 26-50 will be returned.

type
enum<string>
default:all

The type of users you want to return. See the users Overview page for more information about user types.

Available options:
all,
organization,
group
group
string

Filter users by a specific group identifier. Only users that belong to the specified group will be returned.

Response

200

data
string[]