Skip to main content
Use the Broker Panel API to manage client services, process requests, and email reports for your broker account.

​
Make your first request

  1. Create a Sandbox API key with the access your integration needs.
  2. Verify API access from your integration’s network.
  3. Try a read operation before submitting service actions. See Sandbox Mode for simulated behavior and limitations.

​
Base URL and requests

Add the endpoint path, such as /services, to this URL. For example:
Each endpoint page shows the full URL in its request example.
  • Use HTTPS and Bearer authentication on every request.
  • Send Content-Type: application/json for JSON request bodies.
  • Put filters and pagination in the query string, and public service numbers or request IDs in the path.
  • Use GET for reads and POST for the actions specified in the reference.

​
Pagination

List endpoints take limit (rows per response, default 20, maximum 100) and offset (matching rows to skip, default 0). The API changes a limit above 100 to 100, a negative limit to 1, a missing, 0, or non-numeric limit to 20, and a negative offset to 0. The pagination object in the response maps these values to pages: perPage is limit, page is floor(offset / limit) + 1, total is the number of matching rows, and totalPages is ceil(total / limit). You are on the last page when page is equal to or greater than totalPages. When total is 0, totalPages is 0 and data is empty. Use an offset that is a multiple of limit to get predictable page numbers.

​
Responses

Success responses contain success: true and data. List responses also include pagination:
Most successful calls return HTTP 200. Some service and request actions return 202 for processing, manual approval, or NYCServers review. Check the endpoint’s response fields to distinguish acceptance from completion. Errors contain success: false and an error object. Read Errors and Retries for error handling, tracking accepted work, and using idempotency keys before retrying writes.
Last modified on October 4, 2026