Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xerox Sites API

Site discovery and management for print locations

Xerox Sites API is one of 9 APIs that Xerox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 5.5.0.

Requests are made against a single base URL, https://publicprintapi.services.xerox.com/api/v1.

12 operations 8 paths 5 schemas 2 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.5.0
Base URL
https://publicprintapi.services.xerox.com/api/v1
Authentication
API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Xerox Sites API declares 3 security schemes for authenticating requests. An API key is passed in the header as xrxauth (xrxauth). An API key is passed in the header as user-email (userEmail). An API key is passed in the header as appid (appId). By default, every request must be authenticated.

  • xrxauth — Xerox authentication credentials
  • userEmail — User email address for user-context requests
  • appId — Application identifier

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites 12

Site discovery and management for print locations

GET
/Sites
Get Site
getSite 2 params → 200404
PUT
/Sites
Create Site
createSite body → 201400
POST
/Sites
Update Site
updateSite body → 200400
DELETE
/Sites
Delete Site
deleteSite 1 param → 204404
GET
/Sites/Search
Search Sites By Location
searchSitesByLocation 3 params → 200
GET
/Sites/SearchByName
Search Sites By Name
searchSitesByName 3 params → 200
GET
/Sites/SearchByRemoteId
Search Sites By Remote Id
searchSitesByRemoteId 1 param → 200
PUT
/Sites/Favorite
Add Favorite Site
addFavoriteSite 1 param → 200
DELETE
/Sites/Favorite
Remove Favorite Site
removeFavoriteSite 1 param → 204
GET
/Sites/Favorites
List Favorite Sites
listFavoriteSites → 200
POST
/Sites/Sync
Sync Sites
syncSites body → 200
GET
/Sites/UpdateSites
Update Sites From Provider
updateSitesFromProvider 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Site (7 properties), Address (5 properties), SiteListResponse (2 properties), GeoLocation (2 properties). Each schema is shown below with its type and property counts.

GeoLocation
object
Geographic coordinates
2 properties
SiteListResponse
object
List of sites
2 properties
SyncSitesRequest
object
Request to sync site data
1 property
Site
object
A print site (location with printers)
7 properties
Address
object
Physical address
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xerox-sites-api-openapi.yml Raw ↑

Other APIs Xerox publishes across the network.

Xerox Managed Print Services API
Xerox Extensible Interface Platform (EIP)
Xerox FreeFlow SDK
Xerox EULA API
Xerox Jobs API
Xerox Provider Types API
Xerox Providers API
Xerox Status API