ContactList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sinch/main/json-schema/sinch-contact-list-schema.json",
  "title": "ContactList",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sinch-contacts-api-openapi.yml#/components/schemas/ContactList",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "description": "List of contacts",
      "items": {
        "$ref": "#/$defs/Contact"
      }
    },
    "next_page_token": {
      "type": "string",
      "description": "Pagination token for the next page"
    }
  },
  "$defs": {
    "ChannelIdentity": {
      "type": "object",
      "properties": {
        "channel": {
          "type": "string",
          "enum": [
            "SMS",
            "RCS",
            "WHATSAPP",
            "MESSENGER",
            "INSTAGRAM",
            "VIBER",
            "VIBERBM",
            "TELEGRAM",
            "KAKAOTALK",
            "LINE",
            "MMS"
          ],
          "description": "The channel type"
        },
        "identity": {
          "type": "string",
          "description": "The channel-specific identity"
        },
        "app_id": {
          "type": "string",
          "description": "The app ID for the channel"
        }
      }
    },
    "Contact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique contact identifier"
        },
        "display_name": {
          "type": "string",
          "description": "The display name of the contact"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "The contact email address"
        },
        "external_id": {
          "type": "string",
          "description": "An external identifier for the contact"
        },
        "language": {
          "type": "string",
          "description": "The preferred language of the contact"
        },
        "metadata": {
          "type": "string",
          "description": "Contact metadata"
        },
        "channel_identities": {
          "type": "array",
          "description": "The channel identities for the contact",
          "items": {
            "$ref": "#/$defs/ChannelIdentity"
          }
        }
      }
    }
  }
}