API Reference

Branch User Roster Report

Retrieve the branch user roster. Company connection is determined by your auth key.

POSThttps://secure-api.setshape.com/api/reports/branch-retired-users/{crmid}

Replace {crmid} with your Shape system ID — found on the API Integrations page. Every request also needs your auth header — see Using Shape APIs.

Body parameters

Send a filters object containing the report controls.

Field Requirement Description
filters Required Object containing report controls.
slctPerPage Optional Results per page; defaults to 50.
pn Optional One-based page number; defaults to 1.
fromDate Optional Accepted for user-date filtering.
toDate Optional Accepted for user-date filtering.

Example request

{
  "filters": {
    "slctPerPage": 50,
    "pn": 1
  }
}