API Overview

​

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.

curl "https://brokers.newyorkcityservers.com/api/v1/services?limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Base URL and requests

https://brokers.newyorkcityservers.com/api/v1

• 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.

​

Responses

{
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 0,
    "totalPages": 0
  }
}