Skip to main content
GET
https://api.folkyn.com
/
api
/
v1
/
users
List Team Users
curl --request GET \
  --url https://api.folkyn.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "teams": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "first_name": "<string>",
        "last_name": "<string>",
        "job_title": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "current_page": 123,
    "per_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:10
Required range: 1 <= x <= 100
​
status
string

Comma-separated segments — active, pending, expired, undeliverable, or all. Default active,pending.

Example:

"active,pending"

​
role
enum<string>

Filter by team role — team-admin or team-member. Omit for all roles.

Available options:
team-admin,
team-member

Response

Success

​
data
object