Ampersand · JSON Structure

Ampersand Api Builder Structure

Builder schema from Ampersand API

Type: object Properties: 8 Required: 4
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Builder is a JSON Structure definition published by Ampersand, describing 8 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id idpProvider idpRef createTime firstName lastName fullName primaryEmail

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-builder-structure.json",
  "name": "Builder",
  "description": "Builder schema from Ampersand API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The builder ID.",
      "example": "builder-id-123"
    },
    "idpProvider": {
      "type": "string",
      "description": "The identity provider",
      "example": "clerk"
    },
    "idpRef": {
      "type": "string",
      "description": "ID used by the identity provider"
    },
    "createTime": {
      "type": "datetime",
      "description": "The time that the builder joined Ampersand."
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "fullName": {
      "type": "string"
    },
    "primaryEmail": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "idpProvider",
    "idpRef",
    "createTime"
  ]
}