Contact Collection Minimal

Description

contact-collection
List

A collection (or list) of resources.

Properties

Property Description
items
contact[]
Contact Minimal

A collection of resources returned in the current result set.

Property Description
address required nullable
address
Address

The address for this contact.

Property Description
addressLine1 nullable
string
  • ≤ 100 characters

The first line of the address.
addressLine2 nullable
string
  • ≤ 100 characters

The second line of the address, if applicable.
city nullable
string
  • ≤ 50 characters

The city for this address.
country
string
  • = 2 characters

The country code for this address.
name nullable
string
  • ≤ 50 characters

The name of the addressee.
state nullable
string

The state for this address.
stateOther nullable write-only
string
  • ≤ 50 characters

The state property is validated against known states/provinces of all countries. If this address does not have a standard state/province abbreviation, use the stateOther property when creating or updating addresses.

This property is write-only. It is not available in responses.
type
string
enum
  • address

The type of object represented.
zip nullable
either
string
or
integer

The postal code for this address.
email
string
email

The email address for this contact.
firstName nullable
string

The first name for this contact.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
lastName nullable
string

The last name for this contact.
links required read-only
object
Links

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
string

The full name for this contact.
phone nullable
string

The phone number for this contact.
type
string
enum
  • contact
Type

The type of resource represented.
links required read-only
object
Links

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.
meta read-only
object

Metadata describing the current result set.

Property Description
currentPage
integer

The current page of results returned.
rows
integer

The number of rows returned per page for the current result set.
totalItems
integer

The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages
integer

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).
type
string
enum
  • contact-collection
Type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "enum": [
                  "contact"
                ]
              },
              {
                "$ref": "#/components/schemas/Type"
              }
            ]
          }
        },
        "title": "Contact",
        "type": "object"
      },
      "title": "Contact",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "contact-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of Contacts",
  "type": "object"
}
Collection of Contacts