Output Format

Currently, ZoomInfo supports two output formats: XML and JSON. If no output type is specified, output defaults to XML.

XML

You can request XML output in two different ways. One is to use the request parameter, OutputType. The other way is to use the HTTP request header, Accept.

To use the request parameter OutputType for XML output, construct the URL in the following way:

[API_URL]?[SEARCH_CRITERIA]&pc=PartnerCode&OutputType=xml&key=OAuthAccessToken

API_URL refers to the corresponding URL for the intended query. SEARCH_CRITERIA is part of the query string and contains the valid search parameters with values, such as firstName=name1&lastName=name2. Refer to the input parameter tables for each search query type. OutputType is a request parameter you use to specify the intended output format type.

Note: For XML, the OutputType parameter is optional. All the APIs default to XML. 

JSON

You can request JSON output in two different ways. One is to use the request parameter, OutputType. The other way is to use the HTTP request header, Accept.

To use the request parameter OutputType for JSON output, construct the URL in the following way:

[API_URL]?[SEARCH_CRITERIA]&pc=PartnerCode&outputType=json&key=OAuthAccessToken

API_URL refers to the corresponding URL for the intended query. SEARCH_CRITERIA is part of the query string and contains valid searching parameters with values, such asfirstName=name1&lastName=name2. Refer to the input parameter table for the intended query. The OutputType request parameter is used to specify the desired output type (JSON or XML).

HTTP Accept Request Header

The alternative way to specify output type is to include the output type information in the HTTP Accept request header. When using the Accept request header, ensure that this request header has the correct value. Use the following values to specify output type.


Output Type
Accept header Value
XML
application/xml
JSON
application/json


In Java, set the Accept header in the following ways:

String url =
 "https://partnerapi.zoominfo.com/partnerapi/v4/person/search?firstName=joe&pc=
PartnerCode&key=OAuthAccessToken";
HttpClient client = new HttpClient();
GetMethod get = new GetMethod(url);
get.setRequestHeader("Accept", "application/json");
client.executeMethod(get);

The resulting HTTPS request should contain the following content:

GET
"https://partnerapi.zoominfo.com/partnerapi/v4/person/search?firstName=joe&pc=
 PartnerCode&key=OAuthAccessToken";
Accept application/json
Host …..
Origin ….


When using both OutputType query string parameter and the HTTPS Accept header together in the request, the value of OutputType will overrule the Accept header. If the request has neitherOutputType nor Accept header set, the API Server will choose XML as the default output type.

API XML Output Schemas:

The XML Schema API is the interface that allows programs and scripts to access and query information sets. This specification also defines interfaces for loading XML schema documents. The following URLs provide the locations of the published XSDs for each query.


Endpoints that use Oauth


Person Search (output)

Person Detail (output)

Person Match (Output)

Enhanced Person Match (Output)

Company Search (output)

Company Detail (output)

Company Match (output)

Usage Query (output)


Endpoints that do not use any authentication


Person Match Existence (output)

Was this article helpful?

Can’t find what you’re looking for?

Contact our award-winning customer care team.