Wyzio API documentation

Address and uid by contact name

GET /api-v1/contact/address

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Query parameters

name string Required

name

Responses

• 200

OK
Hide response attributes Show response attributes object
- address object
  
  Hide address attributes Show address attributes
  
  city string
  
  countryCode2 string
  
  countryId integer
  
  houseNumber string
  
  id integer
  
  line1 string
  
  line2 string
  
  name string
  
  position integer(int32)
  
  postCode string
  
  readOnly boolean
  
  region object
  
  Hide region attributes Show region attributes
  
  code string
  
  id integer
  
  name string
  
  service string
  
  toTheAttentionOf string
- uid string
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

GET /api-v1/contact/address

curl \
 -X GET http://wyzio.app/api-v1/contact/address?name=string \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

{
  "address": {
    "city": "string",
    "countryCode2": "string",
    "countryId": 42,
    "houseNumber": "string",
    "id": 42,
    "line1": "string",
    "line2": "string",
    "name": "string",
    "position": 42,
    "postCode": "string",
    "readOnly": true,
    "region": {
      "code": "string",
      "id": 42,
      "name": "string"
    },
    "service": "string",
    "toTheAttentionOf": "string"
  },
  "uid": "string"
}