Contact operations#

This section covers the following contact operations:

Get a list of contacts
Get a contact

Get a list of contacts#

This operation returns a list of contacts associated with a customer account.

Method	URI
GET	/v1/customer_accounts/{accountType}/{accountId}/contacts{?role, username, emailAddress, marker, limit}

These tables show the possible response codes for this operation:

Normal response codes:
200 (OK)

Error response codes:
500 (Internal Server Error)
400 (Bad Request)
401 (Unauthorized)
403 (Forbidden)
503 (Service Unavailable)
404 (Not Found)

Request:#

This table shows the URI parameters for the request:

NAME	Type	Description
{accountType}	String	The type of Rackspace customer account.
{accountId}	String	Unique identifier of a Rackspace customer account.

This table shows the query parameters for the request:

NAME	Type	Description
role	String	The role of the contact. This parameter is used as a filter to list all contacts with the given role. Sample values of `role` are `BILLING` and `PRIMARY`.
username	String	The username of the contact.
emailAddress	String	The email address of the contact. This parameter is used as a filter to list all contacts with the given email address.
marker	String	The unique identifier of a contact record.
limit	String	The number of entries returned. If the entered limit is greater than the actual number of entries- the actual number of entries will be used. Defaults to 50. May not exceed 1000.

This operation does not require a request body.

Response:#

XML response:

<?xml version="1.0" encoding="UTF-8"?>
<ns1:contacts xmlns:ns1="http://customer.api.rackspace.com/v1"
    xmlns:ns2="http://www.w3.org/2005/Atom"
    xmlns:ns3="http://docs.rackspace.com/metadata/api" xmlns:ns4="http://customer-admin.api.rackspace.com/v1">
    <ns2:link
        href="https://customer.api.rackspacecloud.comm/v1/customer_accounts/CLOUD/3784384/contacts?marker=1&amp;limit=3" rel="next"/>
    <ns1:contact contactNumber="RPN-000-111-007" firstName="Mike"
        lastName="Jones" rcn="RCN-999-888-777" suffix="Sr" title="Mr" username="john0987">
        <ns1:addresses>
            <ns1:address city="San Antonio" country="US" primary="true"
                state="Texas" street="5000 Walzem Road" zipcode="78218"/>
        </ns1:addresses>
        <ns1:emailAddresses>
            <ns1:emailAddress address="mike.user@example.com" primary="true"/>
        </ns1:emailAddresses>
        <ns1:phoneNumbers>
            <ns1:phoneNumber country="US" mask="(###)-###-####"
                number="8374384343" smsVerify="false" primary="false"/>
        </ns1:phoneNumbers>
        <ns1:roles>
            <ns1:role>TECHNICAL</ns1:role>
        </ns1:roles>
        <ns2:link
            href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-000-111-007" rel="via"/>
    <ns1:notificationPreferences doNotFax="false" doNotCall="true" doNotMail="false" doNotEmail="true" doNotSurvey="false" />
    </ns1:contact>
    <ns1:contact contactNumber="RPN-000-111-008" firstName="Mike"
        lastName="James" rcn="RCN-999-888-777" suffix="Sr" title="Mr">
        <ns1:emailAddresses>
            <ns1:emailAddress address="mike.james@example.com" primary="true"/>
        </ns1:emailAddresses>
        <ns1:phoneNumbers>
            <ns1:phoneNumber country="US" mask="(###)-###-####"
                number="8374384345" smsVerify="false" primary="false"/>
        </ns1:phoneNumbers>
        <ns1:roles>
            <ns1:role>TECHNICAL</ns1:role>
        </ns1:roles>
        <ns2:link
            href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-000-111-008" rel="via"/>
    <ns1:notificationPreferences doNotFax="false" doNotCall="true" doNotMail="false" doNotEmail="true" doNotSurvey="false" />
    </ns1:contact>
    <ns1:contact contactNumber="RPN-000-111-000" firstName="Sarah"
        lastName="Thompson" lastUpdatedBy="user1"
        lastUpdatedDate="2015-04-21T18:00:00.000Z" rcn="RCN-999-888-777"
        suffix="N/A" title="Mrs.">
        <ns1:addresses>
            <ns1:address city="San Antonio" country="US" primary="true"
                state="Texas" street="5000 Walzem Road" zipcode="78218"/>
        </ns1:addresses>
        <ns1:emailAddresses>
            <ns1:emailAddress address="sarah.user@example.com" primary="true"/>
        </ns1:emailAddresses>
        <ns1:phoneNumbers>
            <ns1:phoneNumber country="US" mask="(###)-###-####"
                number="99999999999" smsVerify="false" primary="false"/>
        </ns1:phoneNumbers>
        <ns1:roles>
            <ns1:role>ADMINISTRATIVE</ns1:role>
        </ns1:roles>
        <ns2:link
            href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/7483483/contacts/RPN-000-111-000" rel="via"/>
    <ns1:notificationPreferences doNotFax="false" doNotCall="true" doNotMail="false" doNotEmail="true" doNotSurvey="false" />
    </ns1:contact>
    <ns1:contact contactNumber="RPN-674-533-232" firstName="Katie"
        lastName="Malu" lastUpdatedBy="user1"
        lastUpdatedDate="2015-04-21T18:00:00.000Z" rcn="RCN-999-888-777"
        suffix="Jr." title="Mrs." username="katie.malu">
        <ns1:addresses>
            <ns1:address city="San Antonio" country="US" primary="true"
                state="Texas" street="5000 Walzem Road" zipcode="78218"/>
        </ns1:addresses>
        <ns1:emailAddresses>
            <ns1:emailAddress address="katie.user@example.com" primary="true"/>
        </ns1:emailAddresses>
        <ns1:phoneNumbers>
            <ns1:phoneNumber country="US" mask="(###)-###-####"
                number="7382372378" smsVerify="false" primary="false"/>
        </ns1:phoneNumbers>
        <ns1:roles>
            <ns1:role>TECHNICAL</ns1:role>
        </ns1:roles>
        <ns2:link
            href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-674-533-232" rel="via"/>
    <ns1:notificationPreferences doNotFax="false" doNotCall="true" doNotMail="false" doNotEmail="true" doNotSurvey="false" />
    </ns1:contact>
</ns1:contacts>

JSON response:

{
  "link": [
    {
      "rel": "next",
      "href":
      "https://customer.api.rackspacecloud.comm/v1/customer_accounts/CLOUD/3784384/contacts"
    }
  ],
  "contact": [
    {
      "lastName": "Jones",
      "contactNumber": "RPN-000-111-007",
      "link": [
        {
          "rel": "via",
          "href":
          "https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-000-111-007"
        }
      ],
      "phoneNumbers": {
        "phoneNumber": [
          {
            "mask": "(###)-###-####",
            "number": "8374384343",
            "smsVerify": false,
            "primary": false,
            "country": "US"
          }
        ]
      },
      "notificationPreferences": {
         "doNotFax": false,
         "doNotCall": true,
         "doNotEmail": false,
         "doNotMail": true,
         "doNotSurvey": false
      },
      "suffix": "Sr",
      "username": "john0987",
      "title": "Mr",
      "rcn": "RCN-999-888-777",
      "roles": {
        "role": [
          "TECHNICAL"
        ]
      },
      "addresses": {
        "address": [
          {
            "zipcode": "78218",
            "street": "5000 Walzem Road",
            "primary": true,
            "state": "Texas",
            "country": "US",
            "city": "San Antonio"
          }
        ]
      },
      "firstName": "Mike",
      "emailAddresses": {
        "emailAddress": [
          {
            "address": "mike.user@example.com",
            "primary": true
          }
        ]
      }
    },
    {
      "lastName": "James",
      "contactNumber": "RPN-000-111-008",
      "link": [
        {
          "rel": "via",
          "href":
          "https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-000-111-008"
        }
      ],
      "phoneNumbers": {
        "phoneNumber": [
          {
            "mask": "(###)-###-####",
            "number": "8374384345",
            "smsVerify": false,
            "primary": false,
            "country": "US"
          }
        ]
      },
      "notificationPreferences": {
         "doNotFax": false,
         "doNotCall": true,
         "doNotEmail": false,
         "doNotMail": true,
         "doNotSurvey": false
      },
      "suffix": "Sr",
      "title": "Mr",
      "rcn": "RCN-999-888-777",
      "roles": {
        "role": [
          "TECHNICAL"
        ]
      },
      "firstName": "Mike",
      "emailAddresses": {
        "emailAddress": [
          {
            "address": "mike.james@example.com",
            "primary": true
          }
        ]
      }
    },
    {
      "lastName": "Thompson",
      "contactNumber": "RPN-000-111-000",
      "link": [
        {
          "rel": "via",
          "href":
          "https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/7483483/contacts/RPN-000-111-000"
        }
      ],
      "phoneNumbers": {
        "phoneNumber": [
          {
            "mask": "(###)-###-####",
            "number": "99999999999",
            "smsVerify": false,
            "primary": false,
            "country": "US"
          }
        ]
      },
      "notificationPreferences": {
         "doNotFax": false,
         "doNotCall": true,
         "doNotEmail": false,
         "doNotMail": true,
         "doNotSurvey": false
      },
      "suffix": "N/A",
      "title": "Mrs.",
      "rcn": "RCN-999-888-777",
      "roles": {
        "role": [
          "ADMINISTRATIVE"
        ]
      },
      "lastUpdatedBy": "user1",
      "lastUpdatedDate": "2015-04-21T18:00:00.000Z",
      "addresses": {
        "address": [
          {
            "zipcode": "78218",
            "street": "5000 Walzem Road",
            "primary": true,
            "state": "Texas",
            "country": "US",
            "city": "San Antonio"
          }
        ]
      },
      "firstName": "Sarah",
      "emailAddresses": {
        "emailAddress": [
          {
            "address": "sarah.user@example.com",
            "primary": true
          }
        ]
      }
    },
    {
      "lastName": "Malu",
      "contactNumber": "RPN-674-533-232",
      "link": [
        {
          "rel": "via",
          "href":
          "https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/3784384/contacts/RPN-674-533-232"
        }
      ],
      "phoneNumbers": {
        "phoneNumber": [
          {
            "mask": "(###)-###-####",
            "number": "7382372378",
            "smsVerify": false,
            "primary": false,
            "country": "US"
          }
        ]
      },
      "notificationPreferences": {
         "doNotFax": false,
         "doNotCall": true,
         "doNotEmail": false,
         "doNotMail": true,
         "doNotSurvey": false
      },
      "suffix": "Jr.",
      "username": "katie.malu",
      "title": "Mrs.",
      "rcn": "RCN-999-888-777",
      "roles": {
        "role": [
          "TECHNICAL"
        ]
      },
      "lastUpdatedBy": "user1",
      "lastUpdatedDate": "2015-04-21T18:00:00.000Z",
      "addresses": {
        "address": [
          {
            "zipcode": "78218",
            "street": "5000 Walzem Road",
            "primary": true,
            "state": "Texas",
            "country": "US",
            "city": "San Antonio"
          }
        ]
      },
      "firstName": "Katie",
      "emailAddresses": {
        "emailAddress": [
          {
            "address": "katie.user@example.com",
            "primary": true
          }
        ]
      }
    }
  ]
}

Get a contact#

This operation gets the specified contact for a customer account.

Method	URI
GET	/v1/customer_accounts/{accountType}/{accountId}/contacts/{contactNumber}