Lookup Contact

Retrieves a list of summaries for the top 5 Contacts that best match the provided query

GET https://my.mattero.com.au/public/api/v1/contacts/lookup

Parameters

Name Location Type Description
term Query string:required A term associated with the contact. This checks multiple properties including the title and number properties.
type Query string:optional The status of the contact being searched, expected values are [All | Staff | EnabledStaff].

Response

[
    {
        "id": "897-A",
        "title": "Mr",
        "shortName": "Citizen C",
        "fullName": "Citizen, Craig",
        "company": "Hooli",
        "jobTitle": "Developer",
        "additionalInfo": "craig.citizen@gmail.com"
    }
]

Contact object

Name Type Description
id string The unique identifier associated with a Matter.
title string The contacts title or pronoun.
shortName string An abbreviation for the fullname of the contact.
fullName string The full name of the contact where the formatting is dependent on the type of the contact. A persons full name will have the surname first, followed by the given name, delimited by a comma. A company will just display the full name.
company string The Company associated with the contact.
jobTitle string The job title for the company the associated contact works for.
additionalInfo string Additional identifying information of the contact. This field will contain either the contact's email address, street address or phone number (in that order of priority). This field can be used to help differentiate two contacts with the same name.

Status Codes

Code Summary Description
200 Ok The request was successful with a body in the response.
400 Bad Request The request failed validation checks.
401 Unauthorized Failed authentication check.
403 Forbidden Failed authorization check.