HostingAddressbooks & contacts

Get contact

GET/api/addressbooks/{code}/{addressbook_id}/contacts/{uid}

Returns details for a single contact in an addressbook.

X-Api-Token<token>

API token used to authenticate requests.

In: header

Path Parameters

code*string

Email account code: usually EA followed by 8 digits. Postmaster accounts use P followed by 9 digits. Examples: EA12345678, P123456789.

addressbook_id*integer
Format int32
uid*integer
Format int32

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/addressbooks/string/0/contacts/0" \  -H "X-Api-Token: YOUR_API_TOKEN" \  -H "Accept: application/json"
{
  "resources": [
    {
      "uid": "string",
      "given_name": "string",
      "surname": "string",
      "fullname": "string",
      "nickname": "string",
      "company_name": "string",
      "title": "string",
      "notes": "string",
      "birthday": "string",
      "emails": [
        {
          "value": "string",
          "type": [
            "work"
          ]
        }
      ],
      "phone_numbers": [
        {
          "value": "string",
          "type": [
            "work"
          ]
        }
      ],
      "url": [
        {
          "value": "string",
          "type": "work"
        }
      ],
      "photo": [
        {
          "value": "string",
          "type": "work"
        }
      ],
      "addresses": [
        {
          "street_address": "string",
          "city": "string",
          "postal_code": "string",
          "region": "string",
          "country": "string",
          "type": [
            "work"
          ]
        }
      ]
    }
  ],
  "pagination": {}
}
{
  "message": "Unauthorized",
  "errors": []
}
{
  "message": "Forbidden",
  "errors": []
}
{
  "message": "Not found",
  "errors": []
}
{
  "message": "Validation failed",
  "errors": [
    {
      "field": "name",
      "description": "is not valid"
    }
  ]
}