A minimal representation of a contact.
| Property | Description |
|---|---|
| address required nullable |
The address for this contact. |
|
The email address for this contact. |
|
| firstName nullable |
The first name for this contact. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| lastName nullable |
The last name for this contact. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name nullable |
The full name for this contact. |
| phone nullable |
The phone number for this contact. |
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A minimal representation of a contact.",
"properties": {
"address": {
"allOf": [
{
"description": "The address for this contact.",
"nullable": true
},
{
"$ref": "#/components/schemas/Address"
}
]
},
"email": {
"description": "The email address for this contact.",
"format": "email",
"type": "string"
},
"firstName": {
"description": "The first name for this contact.",
"nullable": true,
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"lastName": {
"description": "The last name for this contact.",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The full name for this contact.",
"nullable": true,
"type": "string"
},
"phone": {
"description": "The phone number for this contact.",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": {
"allOf": [
{
"enum": [
"contact"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"title": "Contact",
"type": "object"
}