Get contact details

This action will return a specific contact configured in the given unit.

Try this request in your browser

/api/ /contacts/info

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id Integer

Structures

Include extended attributes?
Include expansions?

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/contacts/info

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the contact

Integer null

Errors

Error Attributes

ContactNotFound

No contact was found given the ID provided

  • id

    The provided ID

NoAccessToContact

Your authenticated identity is not permitted to access this contact

Response Data

This action will return a address contact structure.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.