v1

latestSwagger 2.02026-08-041113661.2 MB

ContactService

Get contact

get/v1beta/contacts/{id}

Path parameters

idinteger required

Object ID

Query parameters

with_additional_databoolean

Retrieves objects with (1) or without (0) additional data.

Response

A successful response.

codeinteger

descstring

maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "additional_data": {
      "birth_city": "Test city",
      "birth_date": "1969-12-31",
      "social_security_number": "12326178T"
    },
    "address": {
      "city": "Test city",
      "country": "NL",
      "number": "123",
      "state": "Testprovince",
      "street": "Test street",
      "suffix": "A",
      "zipcode": "1235 XX"
    },
    "api_access_enabled": true,
    "api_client_ip_list": {
      "allow": [
        "127.0.0.1"
      ],
      "deny": [
        "127.0.0.1"
      ]
    },
    "auth_type": "simple",
    "comments": "",
    "company_name": "Example company",
    "email": "test@mail.tld",
    "hash_changed_at": "2019-03-25 10:17:02",
    "id": 123456789,
    "is_active": false,
    "last_api_call_at": "2019-03-25 10:17:01",
    "last_login_at": "2019-04-12 11:58:39",
    "locale": "nl_NL",
    "name": {
      "first_name": "Test",
      "full_name": "Test Person",
      "initials": "T P",
      "last_name": "Person",
      "prefix": "Mr"
    },
    "password_change_declined_at": "2019-03-23 12:32:15",
    "password_changed_at": "2019-03-25 10:17:00",
    "phone": {
      "area_code": "111",
      "country_code": "+03",
      "subscriber_number": "123456"
    },
    "rcp_client_ip_list": {
      "allow": [
        "127.0.0.1"
      ],
      "deny": [
        "127.0.0.1"
      ]
    },
    "reseller_id": 12345,
    "role": "admin",
    "secret_key": "SECRETKEYVALUE",
    "username": "user_name",
    "vat": "XX123456789X12"
  },
  "desc": ""
}