Klaviyo · Schema

OnsiteProfileCreateQueryResourceObject

MarketingEmailSMSCustomer DataE-CommerceAutomation

Properties

Name Type Description
type object
id string Primary key that uniquely identifies this profile. Generated by Klaviyo.
attributes object
meta object
View JSON Schema on GitHub

JSON Schema

klaviyo-onsiteprofilecreatequeryresourceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OnsiteProfileCreateQueryResourceObject",
  "title": "OnsiteProfileCreateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ProfileEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
      "type": "string",
      "nullable": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "email": {
          "description": "Individual's email address",
          "type": "string",
          "example": "sarah.mason@klaviyo-demo.com",
          "nullable": true
        },
        "phone_number": {
          "description": "Individual's phone number in E.164 format",
          "type": "string",
          "example": "+15005550006",
          "nullable": true
        },
        "external_id": {
          "description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
          "type": "string",
          "nullable": true
        },
        "anonymous_id": {
          "type": "string",
          "nullable": true
        },
        "_kx": {
          "description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
          "type": "string",
          "nullable": true
        },
        "first_name": {
          "description": "Individual's first name",
          "type": "string",
          "example": "Sarah",
          "nullable": true
        },
        "last_name": {
          "description": "Individual's last name",
          "type": "string",
          "example": "Mason",
          "nullable": true
        },
        "organization": {
          "description": "Name of the company or organization within the company for whom the individual works",
          "type": "string",
          "example": "Example Corporation",
          "nullable": true
        },
        "locale": {
          "description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
          "type": "string",
          "example": "en-US",
          "nullable": true
        },
        "title": {
          "description": "Individual's job title",
          "type": "string",
          "example": "Regional Manager",
          "nullable": true
        },
        "image": {
          "description": "URL pointing to the location of a profile image",
          "type": "string",
          "example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
          "nullable": true
        },
        "location": {
          "$ref": "#/components/schemas/ProfileLocation",
          "nullable": true
        },
        "properties": {
          "description": "An object containing key/value pairs for any custom properties assigned to this profile",
          "type": "object",
          "example": {
            "pseudonym": "Dr. Octopus"
          },
          "nullable": true
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/OnsiteProfileMeta",
      "nullable": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/klaviyo-onsiteprofilecreatequeryresourceobject"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.