Apideck · Schema

CustomersFilter

IntegrationsUnified API

Properties

Name Type Description
company_name string Company Name of customer to search for
display_name string Display Name of customer to search for
first_name string First name of customer to search for
last_name string Last name of customer to search for
email string Email of customer to search for
status string Status of customer to filter on
updated_since string
supplier_id string Supplier ID of customer to search for
View JSON Schema on GitHub

JSON Schema

apideck-customersfilter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomersFilter",
  "title": "CustomersFilter",
  "type": "object",
  "x-apideck-schema-id": "CustomersFilter",
  "example": {
    "company_name": "SpaceX",
    "display_name": "Elon Musk",
    "first_name": "Elon",
    "last_name": "Musk",
    "email": "[email protected]",
    "status": "active",
    "updated_since": "2020-09-30T07:43:32.000Z",
    "supplier_id": "123"
  },
  "properties": {
    "company_name": {
      "type": "string",
      "title": "Company Name",
      "description": "Company Name of customer to search for",
      "example": "SpaceX"
    },
    "display_name": {
      "type": "string",
      "title": "Display Name",
      "description": "Display Name of customer to search for",
      "example": "Techno King"
    },
    "first_name": {
      "type": "string",
      "title": "First Name",
      "description": "First name of customer to search for",
      "example": "Elon"
    },
    "last_name": {
      "type": "string",
      "title": "Last Name",
      "description": "Last name of customer to search for",
      "example": "Musk"
    },
    "email": {
      "type": "string",
      "title": "Email",
      "description": "Email of customer to search for",
      "example": "[email protected]"
    },
    "status": {
      "type": "string",
      "title": "Status",
      "description": "Status of customer to filter on",
      "nullable": true,
      "example": "active",
      "x-apideck-enum-id": "customers.status",
      "enum": [
        "active",
        "inactive",
        "archived",
        "all"
      ]
    },
    "updated_since": {
      "type": "string",
      "title": "Updated since (timestamp)",
      "format": "date-time",
      "example": "2020-09-30T07:43:32.000Z"
    },
    "supplier_id": {
      "type": "string",
      "title": "Supplier ID",
      "description": "Supplier ID of customer to search for",
      "example": "123"
    }
  },
  "additionalProperties": false
}