List accounts

get

https://api-staging.fanheroapi.com/accounts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Retrieve a paginated list of all accounts for an organization.

You have the option to pass pagination parameters in the query. For details, read Pagination.

The ogranization header is required for authentication.

Query Params

pageSize

number

The number of documents that will be returned per page

page

number

Page to search. Page numbering starts with 0.

sortBy

string

The sort-by field name and order. Format: <field_name>.<asc|desc> (asc for ascending and desc for descending order). If no order is specified, descending order is used.

tenant_id

string

Tenant ID

email__exact

string

Filter by email address.

username__exact

string

Filter by user name.

username__contains

string

Return only accounts where the user name contains this string.

first_name__exact

string

Filter by owner's first name.

first_name__contains

string

Return only accounts where the owner's first name contains this string.

last_name__exact

string

Filter by owner's last name.

last_name__contains

string

Return only accounts where the owner's last name contains this string.

is_admin

boolean

Return only admin accounts.

active

boolean | null

If True, return only active accounts.

block_temp

date-time | null

Return only accounts temporarily blocked until this date.

block_perm

boolean | null

Return only permanently blocked accounts.

pending_activation

boolean | null

If True, return only accounts that are pending activation.

gdpr

boolean | null

Return only accounts that have a GDPR requirement.

term

string

Filter by this term.

Headers

organization

string

required

The URL of the end-user web application

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Overview

200Successful resopnse