Skip to main content
GET
/
platform
/
users
TypeScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useautumn.com/v1/platform/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "list": [
    {
      "email": "jsmith@example.com",
      "created_at": 123,
      "organizations": [
        {
          "slug": "<string>",
          "name": "<string>",
          "created_at": 123
        }
      ]
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs-v1.useautumn.com/llms.txt

Use this file to discover all available pages before exploring further.

Lists all users created by your master organization. Supports pagination and optional expansion of related organizations.

Authorizations

​
Authorization
string
header
required

Autumn API key with Bearer prefix

Query Parameters

​
limit
integer
default:10

Number of users to return (1-100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of users to skip for pagination

Required range: x >= 0
​
expand
string

Comma-separated list of fields to expand. Currently supports: 'organizations'

Response

Users retrieved successfully

​
list
object[]
​
total
number

Total number of users returned.

​
limit
number

Limit used in the query.

​
offset
number

Offset used in the query.