Sign in
Contacts

Retrieve a contact

Retrieves detailed information about a specific contact.

get/v1/contacts/{contactId}

Path parameters

contactIdstring required

The ID of the contact that you want to retrieve.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

accountIdstring

The ID of the account associated with the contact.

accountNumberstring

The number of the customer account associated with the contact.

address1string

The first line of the contact's address, which is often a street address or business name.

address2string

The second line of the contact's address.

asBillToboolean

Indicates whether the contact can be specified as a bill-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.

asShipToboolean

Indicates whether the contact can be specified as a ship-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.

asSoldToboolean

Indicates whether the contact can be specified as a sold-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.

citystring

The city of the contact's address.

contactDescriptionstring

A description for the contact.

countrystring

The full country name of the contact's address.

countystring nullable

The county. May optionally be used by Zuora Tax to calculate county tax.

faxstring

The contact's fax number.

firstNamestring

The contact's first name.

homePhonestring

The contact's home phone number.

lastNamestring

The contact's last name.

mobilePhonestring

The mobile phone number of the contact.

nicknamestring

A nickname for the contact.

otherPhonestring

An additional phone number for the contact.

otherPhoneType'Work' | 'Mobile' | 'Home' | 'Other'

The type of the additional phone number.

personalEmailstring

The contact's personal email address.

statestring

The full state or province name of the contact's address.

successboolean

Returns true if the request was processed successfully.

taxRegionstring

If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.

workEmailstring

The contact's business email address.

workPhonestring

The contact's business phone number.

zipCodestring

The zip code for the contact's address.

Changes