FAfanhero
Permissions

List permissions

get/permissions

Request

  • Base URL
    https://api-staging.fanheroapi.com
  • URL
    https://api-staging.fanheroapi.com/permissions
  • Auth
    API key in header apiKey

Query parameters

pagenumber

Page to search. Page numbering starts with 0.

pageSizenumber

The umber of documents that will be returned per page. Defaults to 20.

direction'ASC' | 'DESC'

Sort direction. Ascending or Descending. Enum

field'name'

Name of the sort-by field

Headers

organizationstring required

The URL of the end-user web application

Response

Successful resopnse

pageinteger

The current page

pageSizeinteger

The number of objects per page

totalinteger

The total number of objects in the response

pageCountinteger

The total number of pages

pageNumberIsGoodboolean

Page number is valid.

hasPreviousPageboolean

There is a previous page.

hasNextPageboolean

There is a next page.

isFirstPageboolean

This is the first page.

isLastPageboolean

This is the last page.

Example response

{
  "page": 1,
  "pageSize": 20,
  "total": 1,
  "pageCount": 1,
  "pageNumberIsGood": true,
  "isFirstPage": true,
  "isLastPage": true,
  "rows": [
    {
      "subject": {
        "id": "896632c05f1a59b6d395b963",
        "fields": [
          "name",
          "address"
        ],
        "entity": "accountstatuses"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.