Homepage

remote_users

Last edit: Nov 10, 2026

Returns users fetched from a remote endpoint. Sends a GET request to the
endpoint with filter, sort, page and per_page as query parameters and expects
a JSON response shaped like a users collection. An endpoint on a domain of
this platform is rendered directly. Not available in requests sent by another
platformOS instance. A failed request is logged and returns no results.

remote_users(
  endpoint: Endpoint!
  filter: UsersFilterInput
  page: Int = 1
  per_page: Int!
  sort: [UsersSortInput!]
): UserCollection!

Arguments

endpoint (Endpoint)

Endpoint that returns the users as JSON

filter (UsersFilterInput)

Conditions the returned results must match. All conditions are combined with AND. Passed to the endpoint

page (Int)

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

per_page (Int)

Number of results per page, must be greater than 0

sort (UsersSortInput)

Sort order passed to the endpoint

Type

UserCollection

Paginated list of users

Questions?

We are always happy to help with any questions you may have.

contact us