Charthop

Charthop band API

The band API from Charthop — 6 operation(s) for band.

GitHub OpenAPI
Business capability
Compensation & Benefits Management BC-300.30

Operations 10

GET /v1/org/{orgId}/band Find comp bands in the organization #
POST /v1/org/{orgId}/band Create a comp band #
DELETE /v1/org/{orgId}/band Delete all comp bands on a date #
POST /v1/org/{orgId}/band/bulkupdate Perform a bulk update on comp bands #
GET /v1/org/{orgId}/band/count Return the count of comp bands in the organization #
DELETE /v1/org/{orgId}/band/reset Delete all comp band data on a date #
GET /v1/org/{orgId}/band/schema Get comp band schema with job tier field configurations and their possible values #
GET /v1/org/{orgId}/band/{bandId} Return a particular comp band by id on an effective date #
PATCH /v1/org/{orgId}/band/{bandId} Update a comp band #
DELETE /v1/org/{orgId}/band/{bandId} Delete a comp band #

Documentation

📖
Documentation
https://docs.charthop.com/developer-basics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-band-api-openapi.yml

Other Resources

🔗
Swagger
https://api.charthop.com/swagger

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/charthop-band-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

charthop-band-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Band API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: band
paths:
  /v1/org/{orgId}/band:
    get:
      tags:
      - band
      summary: Find comp bands in the organization
      operationId: findCompBands
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: from
        in: query
        description: Table id to start paginating from
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: includeDeleted
        in: query
        description: Include deleted bands
        required: false
        schema:
          type: boolean
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      - name: jobTierOne
        in: query
        description: Filter by job tier one value
        required: false
        schema:
          type: string
      - name: jobTierTwo
        in: query
        description: Filter by job tier two value
        required: false
        schema:
          type: string
      - name: jobTierThree
        in: query
        description: Filter by job tier three value
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort by CompBand field (e.g., label, baseCompMin, baseCompMax)
        required: false
        schema:
          type: string
      - name: jobLevel
        in: query
        description: Filter by job level label
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsCompBand'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - band
      summary: Create a comp band
      operationId: createCompBand
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of band creation
        required: false
        schema:
          type: string
          format: date
      responses:
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCompBand'
        required: true
    delete:
      tags:
      - band
      summary: Delete all comp bands on a date
      operationId: deleteAllCompBands
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of group update
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
  /v1/org/{orgId}/band/bulkupdate:
    post:
      tags:
      - band
      summary: Perform a bulk update on comp bands
      operationId: bulkUpdate
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
        '400':
          description: bad request
        '401':
          description: not authorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCompBandUpdateRequest'
        required: true
  /v1/org/{orgId}/band/count:
    get:
      tags:
      - band
      summary: Return the count of comp bands in the organization
      operationId: countCompBands
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: jobTierOne
        in: query
        description: Filter by job tier one value
        required: false
        schema:
          type: string
      - name: jobTierTwo
        in: query
        description: Filter by job tier two value
        required: false
        schema:
          type: string
      - name: jobTierThree
        in: query
        description: Filter by job tier three value
        required: false
        schema:
          type: string
      - name: jobLevel
        in: query
        description: Filter by job level label
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompBandCount'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v1/org/{orgId}/band/reset:
    delete:
      tags:
      - band
      summary: Delete all comp band data on a date
      operationId: resetCompBands
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of group update
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
  /v1/org/{orgId}/band/schema:
    get:
      tags:
      - band
      summary: Get comp band schema with job tier field configurations and their possible values
      operationId: getCompBandSchema
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompBandSchema'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v1/org/{orgId}/band/{bandId}:
    get:
      tags:
      - band
      summary: Return a particular comp band by id on an effective date
      operationId: getCompBandById
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: bandId
        in: path
        description: Comp band id
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompBand'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    patch:
      tags:
      - band
      summary: Update a comp band
      operationId: updateCompBand
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: bandId
        in: path
        description: Band id
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of band update
        required: false
        schema:
          type: string
          format: date
      responses:
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCompBand'
        required: true
    delete:
      tags:
      - band
      summary: Delete a comp band
      operationId: deleteCompBand
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: bandId
        in: path
        description: Comp band id
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of group update
        required: false
        schema:
          type: string
          format: date
      responses:
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
components:
  schemas:
    Money:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          type: number
        currency:
          type: string
        places:
          type: integer
          format: int32
    EnumValue:
      type: object
      required:
      - name
      - label
      properties:
        name:
          type: string
          description: enum value name
        label:
          type: string
          description: enum value label
        color:
          type: string
          description: color of property
          pattern: ^#[a-f0-9]{6}$
        expr:
          type: string
          description: computed expression, for ENUM_EXPR type
        num:
          type: number
          description: numeric value, for ENUM_SCALE type
        sort:
          type: integer
          format: int32
          description: sort order
        rank:
          type: integer
          format: int32
          description: rank order, if selected in rank order
        id:
          type: string
          description: unique identifier for enum
          example: 588f7ee98f138b19220041a7
        labelTr:
          description: translations for the label
          $ref: '#/components/schemas/Translations'
    BulkCompBandUpdateRequest:
      type: object
      required:
      - updates
      properties:
        updates:
          type: array
          description: List of update operations to perform
          items:
            $ref: '#/components/schemas/CompBandUpdateOperation'
        date:
          type: string
          format: date
          description: Effective date for all updates
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    TableRowRef:
      type: object
      required:
      - tableId
      - tableName
      - id
      properties:
        tableId:
          type: string
          example: 588f7ee98f138b19220041a7
        tableName:
          type: string
        id:
          type: string
          example: 588f7ee98f138b19220041a7
        label:
          type: object
    ResultsCompBand:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompBand'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    AccessAction:
      type: object
      required:
      - action
      properties:
        action:
          type: string
        fields:
          type: array
          uniqueItems: true
          items:
            type: string
        types:
          type: array
          uniqueItems: true
          items:
            type: string
    Process:
      type: object
      required:
      - id
      - orgId
      - label
      - type
      - status
      - runUserId
      - createId
      - createAt
      - options
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: parent org id
          example: 588f7ee98f138b19220041a7
        label:
          type: string
          description: human-readable label that identifies this process
        type:
          type: string
          description: process type
        status:
          type: string
          description: current status of process
          enum:
          - PENDING
          - RUNNING
          - DONE
          - ERROR
        filePath:
          type: string
          description: data file path
        logPath:
          type: string
          description: data log path
        runUserId:
          type: string
          description: user id who is running the process
          example: 588f7ee98f138b19220041a7
        parentProcessId:
          type: string
          description: process id of parent process
          example: 588f7ee98f138b19220041a7
        createId:
          type: string
          description: created by user id (user who requested the process run)
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        startAt:
          type: string
          description: started at timestamp
          example: '2017-01-24T13:57:52Z'
        endAt:
          type: string
          description: ended at timestamp
          example: '2017-01-24T13:57:52Z'
        message:
          type: string
          description: status or error message
        progress:
          type: number
          format: double
          description: percent progress so far
        internalError:
          type: string
          description: internal-only error message
        options:
          type: object
          description: options passed to the process
        results:
          type: object
          description: results summary for the process
          additionalProperties:
            type: object
        logDataList:
          type: array
          description: list of log data that occurred during running of this process
          items:
            $ref: '#/components/schemas/LogData'
        state:
          type: object
          description: process-specific state data
        summary:
          type: string
          description: human-readable, searchable summary of what this process did
        appId:
          type: string
          description: app id of the process
          example: 588f7ee98f138b19220041a7
        uuid:
          type: string
          description: unique ID of the process at queue time
          example: 84db3c6e-0877-4436-8af1-768c06b29586
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    CompBandCount:
      type: object
      required:
      - bandCount
      properties:
        bandCount:
          type: integer
          format: int64
    Translations:
      type: object
      required:
      - values
      properties:
        values:
          type: object
          additionalProperties:
            type: string
    CompBandUpdateOperation:
      type: object
      required:
      - compBandId
      - update
      properties:
        compBandId:
          type: string
          description: Comp band ID to update
          example: 588f7ee98f138b19220041a7
        update:
          description: Update data
          $ref: '#/components/schemas/UpdateCompBand'
    UpdateCompBand:
      type: object
      required:
      - label
      - color
      - baseInterval
      properties:
        label:
          type: string
          description: human-readable name of content
          example: L15
        color:
          type: string
          description: hex color associated with the band level
          example: '#ffee4a'
        baseCompMax:
          description: maximum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMid:
          description: midpoint base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMin:
          description: minimum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseSpread:
          type: number
          description: spread percent used to calculate base comp from the midpoint
        baseInterval:
          description: interval of compensation for the base, hourly or annual
          $ref: '#/components/schemas/EnumValue'
        baseTargetPay:
          description: base target pay associated with open jobs at this band level
          $ref: '#/components/schemas/Money'
        baseTargetPayPercentile:
          type: number
          description: base target pay associated with open jobs at this band level, as a percentile
        equityTargetShares:
          type: number
          description: target equity for the band, in shares
        equityTargetPercentOfBase:
          type: number
          description: target equity for the band, as a percentage of base
        equityTargetValue:
          type: number
          description: target equity for the band, as a monetary value, in the same currency as the base
        equityRefreshShares:
          type: number
          description: refresh grant equity for the band, in shares
        equityRefreshPercentOfBase:
          type: number
          description: refresh grant equity for the band, as a percentage of base
        equityRefreshValue:
          type: number
          description: refresh grant equity for the band, as a monetary value, in the same currency as the base
        variableValue:
          description: variable compensation for the band
          $ref: '#/components/schemas/Money'
        variablePercentOfBase:
          type: number
          description: variable compensation for the band, specified as a percentage of base
        startingSalary:
          description: the default starting salary for this band
          $ref: '#/components/schemas/Money'
        jobTierOneField:
          description: first job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierTwoField:
          description: second job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierThreeField:
          description: third job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobLevel:
          type: string
          description: job level associated with the comp band
          example: 588f7ee98f138b19220041a7
    CompBandSchema:
      type: object
      required:
      - jobLevelValues
      - fields
      properties:
        jobLevelValues:
          type: array
          description: Job level values
          items:
            type: string
        jobTierOneField:
          description: First job tier field configuration
          $ref: '#/components/schemas/JobTierFieldSchema'
        jobTierTwoField:
          description: Second job tier field configuration
          $ref: '#/components/schemas/JobTierFieldSchema'
        jobTierThreeField:
          description: Third job tier field configuration
          $ref: '#/components/schemas/JobTierFieldSchema'
        fields:
          type: array
          description: List of available compensation fields that have non-null values across comp bands
          items:
            type: string
    CreateCompBand:
      type: object
      required:
      - label
      - color
      - baseInterval
      - jobLevel
      properties:
        label:
          type: string
          description: human-readable name of content
          example: L15
        color:
          type: string
          description: hex color associated with the band level
          example: '#ffee4a'
        baseCompMax:
          description: maximum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMid:
          description: midpoint base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMin:
          description: minimum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseSpread:
          type: number
          description: spread percent used to calculate base comp from the midpoint
        baseInterval:
          description: interval of compensation for the base, hourly or annual
          $ref: '#/components/schemas/EnumValue'
        baseTargetPay:
          description: base target pay associated with open jobs at this band level
          $ref: '#/components/schemas/Money'
        baseTargetPayPercentile:
          type: number
          description: base target pay associated with open jobs at this band level, as a percentile
        equityTargetShares:
          type: number
          description: target equity for the band, in shares
        equityTargetPercentOfBase:
          type: number
          description: target equity for the band, as a percentage of base
        equityTargetValue:
          type: number
          description: target equity for the band, as a monetary value, in the same currency as the base
        equityRefreshShares:
          type: number
          description: refresh grant equity for the band, in shares
        equityRefreshPercentOfBase:
          type: number
          description: refresh grant equity for the band, as a percentage of base
        equityRefreshValue:
          type: number
          description: refresh grant equity for the band, as a monetary value, in the same currency as the base
        variableValue:
          description: variable compensation for the band
          $ref: '#/components/schemas/Money'
        variablePercentOfBase:
          type: number
          description: variable compensation for the band, specified as a percentage of base
        startingSalary:
          description: the default starting salary for this band
          $ref: '#/components/schemas/Money'
        jobTierOneField:
          description: first job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierTwoField:
          description: second job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierThreeField:
          description: third job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobLevel:
          type: string
          description: job level associated with the comp band
          example: 588f7ee98f138b19220041a7
    JobTierFieldSchema:
      type: object
      required:
      - values
      properties:
        code:
          type: string
          description: Field code (e.g., department)
        values:
          type: array
          description: All possible values for this field across comp bands
          items:
            type: string
    JobTierField:
      type: object
      required:
      - value
      properties:
        code:
          type: string
        value:
          type: string
    CompBand:
      type: object
      required:
      - id
      - orgId
      - label
      - color
      - baseInterval
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: parent organization id
          example: 588f7ee98f138b19220041a7
        label:
          type: string
          description: human-readable name of content
          example: L15
        color:
          type: string
          description: hex color associated with the band level
          example: '#ffee4a'
        baseCompMax:
          description: maximum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMid:
          description: midpoint base compensation for the band
          $ref: '#/components/schemas/Money'
        baseCompMin:
          description: minimum base compensation for the band
          $ref: '#/components/schemas/Money'
        baseSpread:
          type: number
          description: spread percent used to calculate base comp from the midpoint
        baseInterval:
          description: interval of compensation for the base, hourly or annual
          $ref: '#/components/schemas/EnumValue'
        baseTargetPay:
          description: base target pay associated with open jobs at this band level
          $ref: '#/components/schemas/Money'
        baseTargetPayPercentile:
          type: number
          description: target pay associated with open jobs at this band level, specified as a percentile of [min,max]
        jobTierOneField:
          description: first job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierTwoField:
          description: second job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobTierThreeField:
          description: third job tier associated with the comp band
          $ref: '#/components/schemas/JobTierField'
        jobLevel:
          description: job level associated with the comp band
          $ref: '#/components/schemas/TableRowRef'
        equityTargetShares:
          type: number
          description: target equity for the band, in shares
        equityTargetPercentOfBase:
          type: number
          description: target equity for the band, as a percentage of base
        equityTargetValue:
          type: number
          description: target equity for the band, as a monetary value, in the same currency as the org
        equityRefreshShares:
          type: number
          description: refresh grant equity for the band, in shares
        equityRefreshPercentOfBase:
          type: number
          description: refresh grant equity for the band, as a percentage of base
        equityRefreshValue:
          type: number
          description: refresh grant equity for the band, as a monetary value, in the same currency as the org
        variableValue:
          description: variable compensation for the band
          $ref: '#/components/schemas/Money'
        variablePercentOfBase:
          type: number
          description: variable compensation for the band, specified as a percentage of base
        startingSalary:
          description: the default starting salary for this band
          $ref: '#/components/schemas/Money'
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
        createDate:
          type: string
          format: date
          description: when this entity starts existing in org history
        deleteDate:
          type: string
          format: date
          description: when this entity stops existing in org history
    LogData:
      type: object
      required:
      - level
      - at
      - data
      properties:
        level:
          type: string
          enum:
          - INFO
          - WARN
          - ERROR
        at:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        message:
          type: string
        data:
          type: object
          additionalProperties:
            type: object