List Services

List Services

curl --request GET \
  --url https://brokers.newyorkcityservers.com/api/v1/services \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brokers.newyorkcityservers.com/api/v1/services', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brokers.newyorkcityservers.com/api/v1/services",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://brokers.newyorkcityservers.com/api/v1/services"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "service_number": 1001,
      "customer_name": "Example Trading Ltd",
      "customer_email": "admin@example.com",
      "customer_phone": "+1-212-555-0100",
      "plan": "Standard VPS",
      "service_status": "active",
      "created_date": "2026-04-01T09:30:00.000Z",
      "next_billing_date": "2026-05-01",
      "last_modified": "2026-04-12T14:22:33.000Z",
      "notes": null
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "totalPages": 1
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_parameter",
    "message": "Invalid status. Must be one of: active, pending, suspended, cancelled",
    "details": {
      "parameter": "status",
      "valid_values": [
        "active",
        "pending",
        "suspended",
        "cancelled"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key"
  }
}

{
  "success": false,
  "error": {
    "code": "insufficient_permissions",
    "message": "IP address not whitelisted"
  }
}

{
  "success": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded"
  }
}

{
  "success": false,
  "error": {
    "code": "server_error",
    "message": "Internal server error"
  }
}

GET

services

List Services

curl --request GET \
  --url https://brokers.newyorkcityservers.com/api/v1/services \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brokers.newyorkcityservers.com/api/v1/services', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brokers.newyorkcityservers.com/api/v1/services",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://brokers.newyorkcityservers.com/api/v1/services"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "service_number": 1001,
      "customer_name": "Example Trading Ltd",
      "customer_email": "admin@example.com",
      "customer_phone": "+1-212-555-0100",
      "plan": "Standard VPS",
      "service_status": "active",
      "created_date": "2026-04-01T09:30:00.000Z",
      "next_billing_date": "2026-05-01",
      "last_modified": "2026-04-12T14:22:33.000Z",
      "notes": null
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "totalPages": 1
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_parameter",
    "message": "Invalid status. Must be one of: active, pending, suspended, cancelled",
    "details": {
      "parameter": "status",
      "valid_values": [
        "active",
        "pending",
        "suspended",
        "cancelled"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key"
  }
}

{
  "success": false,
  "error": {
    "code": "insufficient_permissions",
    "message": "IP address not whitelisted"
  }
}

{
  "success": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded"
  }
}

{
  "success": false,
  "error": {
    "code": "server_error",
    "message": "Internal server error"
  }
}

Returns a paginated list of services that belong to the authenticated broker. The full endpoint is GET /api/v1/services. The request does not have a body.

Filtering And Order

The API applies all specified filters before it applies offset and limit. Without modified_since, the API sorts services by created_date in descending order. With modified_since, the API sorts by last_modified in ascending order. It then sorts equal timestamps by service_number in ascending order. The modified_since boundary is inclusive. A service can occur in two polling responses when its last_modified value is equal to the boundary. Use service_number as the public record identifier when processing repeated results. The pagination.page value is floor(offset / limit) + 1. For predictable page numbers, use an offset that is a multiple of limit.

Errors

Error responses use success: false and an error object.

HTTP status	Error code	Cause
`400`	`invalid_parameter`	`status` is not one of the four accepted values.
`400`	`invalid_parameter`	`modified_since` is not a full ISO 8601 timestamp with a timezone.
`401`	`authentication_failed`	The Bearer token is missing, invalid, inactive, or expired.
`403`	`insufficient_permissions`	The key does not have `services:read` or `admin:full`.
`403`	`insufficient_permissions`	`include_credentials=true` is present, but the key does not have `admin:full`.
`403`	`insufficient_permissions`	The request IP address is not allowed for the key.
`429`	`rate_limit_exceeded`	The key reached its rate limit. The `Retry-After` header contains the wait time in seconds.
`500`	`server_error`	The API could not get the services or could not complete the request.

Authorizations

Authorization

string

header

required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Query Parameters

limit

integer

default:20

Maximum rows returned; runtime clamps the value to 1–100.

Required range: 1 <= x <= 100

offset

integer

default:0

Number of matching rows to skip; runtime clamps negative values to zero.

Required range: x >= 0

status

enum<string>

Available options:

active,

pending,

suspended,

cancelled

string

Case-insensitive customer name/email search, or exact numeric service number.

modified_since

string<date-time>

Inclusive full ISO 8601 timestamp with timezone.

include_credentials

boolean

default:false

Set to true to include cached VPS credentials; requires admin:full.

Response

Paginated service list.

success

boolean

required

pagination

object

required

Show child attributes

data

object[]

required

Show child attributes

message

string

Last modified on August 2, 2026

Getting Started

Services

Requests

Reports

Filtering And Order

Errors

Authorizations

Query Parameters

Response

​Filtering And Order

​Errors

Authorizations

Query Parameters

Response

Filtering And Order

Errors