GET api/Contacts/{id}

Retrieves information for a contact.

Request

Parameters

Name	Description	Default
`id`	Contact number (unique ID).
`includeRelated`	Whether definitions for related contacts are included inline.	`false`
`notesFormat`	Desired format for the contact notes field.	`rtf`

Response

Body

Content Type: application/xml
Schema: http://download.overtech.com.au/schemas/XmlContact.xsd
Exported contact definition or an error message.

Status Codes

Code	Condition
200 OK	The operation completed successfully.
400 Bad Request	Invalid contact number.
401 Unauthorized	Access token is invalid, expired or not specified.
404 Not Found	Contact not found.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.
501 Not Implemented	Server does not have the required plug-in.

Remarks

The notes format can be one of the following values:

Value	Description
`rtf`	Rich Text Format.
`html`	HTML Format.
`text`	Plain Text Format.

When includeRelated is set to true, the full definition for each related contact is included inline. Otherwise, only their names and identifiers are included in the output.