get-accounts

get

get-accounts

Retrieves a list of accounts including details about each account and its nested objects.

Resource URL

https://api.pepperi.com/v1.0 /accounts

Query Parameters


Name Values Description
page

Page index.

page_size

Number of records per page. (100 by default, 250 max)

where

Filter results by SQL-Style where clause.

order_by

Defines the sort order of the results.

fields

Return specified fields only. (comma delimited)

include_deleted

Include records in "Hidden" status.

include_nested

Include one-to-many nested objects.

include_count

Include records and pages counting as custom headers.

full_mode

Include all fields of one-to-one related objects.

is_distinct

When set to true retrieves distinct values based on the fields parameter.


Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Bad Request

  • 401
    401

    Not Authorized

  • 404
    404

    Not Found

  • 500
    500

    Internal server error

Resource Summary

Security

Content Type

application/json

Category

Accounts

Working...