Skip to content
HALOWERK

Formatwerk

vcard generate

Own serializer for vCard 4.0: N and ADR are compound values with comma-separated lists per component, TEXT values escape backslash, comma and newlines and, in the compound properties N, ADR, ORG and GENDER, semicolons (RFC 6350 3.4), multiple TYPE values are quoted as in the RFC examples, international phone numbers become tel: URIs with optional ext, dates accept full dates, --MM-DD and date-times with offsets, lines are folded at 75 octets on UTF-8 character boundaries with CRLF. FN is.

POST https://format.halowerk.com/v1/vcard-generate

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
contactsarrayYes
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "contacts"
  ],
  "properties": {
    "contacts": {
      "type": "array",
      "minItems": 1,
      "maxItems": 500,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "formatted_name": {
            "type": "string",
            "maxLength": 300
          },
          "name": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "family": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 200
                  },
                  {
                    "type": "array",
                    "maxItems": 10,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    }
                  }
                ]
              },
              "given": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 200
                  },
                  {
                    "type": "array",
                    "maxItems": 10,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    }
                  }
                ]
              },
              "additional": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 200
                  },
                  {
                    "type": "array",
                    "maxItems": 10,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    }
                  }
                ]
              },
              "prefixes": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 200
                  },
                  {
                    "type": "array",
                    "maxItems": 10,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    }
                  }
                ]
              },
              "suffixes": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 200
                  },
                  {
                    "type": "array",
                    "maxItems": 10,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    }
                  }
                ]
              }
            }
          },
          "kind": {
            "type": "string",
            "enum": [
              "individual",
              "group",
              "org",
              "location"
            ]
          },
          "nicknames": {
            "type": "array",
            "maxItems": 10,
            "items": {
              "type": "string",
              "maxLength": 100
            }
          },
          "organization": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 300
              },
              {
                "type": "array",
                "maxItems": 5,
                "items": {
                  "type": "string",
                  "maxLength": 300
                }
              }
            ]
          },
          "organization_type": {
            "type": "string",
            "enum": [
              "work",
              "home"
            ]
          },
          "title": {
            "type": "string",
            "maxLength": 300
          },
          "role": {
            "type": "string",
            "maxLength": 300
          },
          "emails": {
            "type": "array",
            "maxItems": 20,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "value"
              ],
              "properties": {
                "value": {
                  "type": "string",
                  "format": "email"
                },
                "type": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "work",
                        "home"
                      ]
                    },
                    {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "work",
                          "home"
                        ]
                      }
                    }
                  ]
                },
                "pref": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              }
            }
          },
          "phones": {
            "type": "array",
            "maxItems": 20,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "value"
              ],
              "properties": {
                "value": {
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 50
                },
                "ext": {
                  "type": "string",
                  "maxLength": 10
                },
                "type": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "array",
                      "maxItems": 8,
                      "items": {
                        "type": "string",
                        "enum": [
                          "work",
                          "home",
                          "text",
                          "voice",
                          "fax",
                          "cell",
                          "video",
                          "pager",
                          "textphone"
                        ]
                      }
                    }
                  ]
                },
                "pref": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              }
            }
          },
          "addresses": {
            "type": "array",
            "maxItems": 10,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "po_box": {
                  "type": "string",
                  "maxLength": 300
                },
                "extended": {
                  "type": "string",
                  "maxLength": 300
                },
                "street": {
                  "type": "string",
                  "maxLength": 300
                },
                "locality": {
                  "type": "string",
                  "maxLength": 300
                },
                "region": {
                  "type": "string",
                  "maxLength": 300
                },
                "postal_code": {
                  "type": "string",
                  "maxLength": 300
                },
                "country": {
                  "type": "string",
                  "maxLength": 300
                },
                "label": {
                  "type": "string",
                  "maxLength": 300
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "work",
                    "home"
                  ]
                },
                "pref": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              }
            }
          },
          "urls": {
            "type": "array",
            "maxItems": 10,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "value"
              ],
              "properties": {
                "value": {
                  "type": "string",
                  "format": "uri"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "work",
                    "home"
                  ]
                },
                "pref": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              }
            }
          },
          "keys": {
            "type": "array",
            "maxItems": 5,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "value"
              ],
              "properties": {
                "value": {
                  "type": "string",
                  "format": "uri"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "work",
                    "home"
                  ]
                }
              }
            }
          },
          "birthday": {
            "type": "string",
            "maxLength": 30
          },
          "anniversary": {
            "type": "string",
            "maxLength": 30
          },
          "gender": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "sex": {
                "type": "string",
                "enum": [
                  "M",
                  "F",
                  "O",
                  "N",
                  "U",
                  ""
                ]
              },
              "identity": {
                "type": "string",
                "maxLength": 100
              }
            }
          },
          "languages": {
            "type": "array",
            "maxItems": 10,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "tag"
              ],
              "properties": {
                "tag": {
                  "type": "string",
                  "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
                },
                "pref": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              }
            }
          },
          "timezone": {
            "type": "string",
            "maxLength": 64
          },
          "geo": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "lat",
              "lon"
            ],
            "properties": {
              "lat": {
                "type": "number",
                "minimum": -90,
                "maximum": 90
              },
              "lon": {
                "type": "number",
                "minimum": -180,
                "maximum": 180
              },
              "type": {
                "type": "string",
                "enum": [
                  "work",
                  "home"
                ]
              }
            }
          },
          "categories": {
            "type": "array",
            "maxItems": 20,
            "items": {
              "type": "string",
              "maxLength": 100
            }
          },
          "note": {
            "type": "string",
            "maxLength": 10000
          },
          "members": {
            "type": "array",
            "maxItems": 200,
            "items": {
              "type": "string",
              "format": "uri"
            }
          },
          "rev": {
            "type": "string",
            "maxLength": 30
          },
          "uid": {
            "type": "string",
            "maxLength": 255
          }
        }
      }
    }
  }
}

Open original schema

Published input example

{
  "contacts": [
    {
      "formatted_name": "HALOWERK API",
      "kind": "org",
      "organization": "HALOWERK",
      "emails": [
        {
          "value": "api@halowerk.com",
          "type": "work"
        }
      ],
      "urls": [
        {
          "value": "https://halowerk.com/",
          "type": "work"
        }
      ]
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’