Charthop

Charthop person API

The person API from Charthop — 8 operation(s) for person.

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 11

GET /v2/org/{orgId}/person Find persons in the organization #
POST /v2/org/{orgId}/person Create a person #
GET /v2/org/{orgId}/person/count Count persons in an org #
GET /v2/org/{orgId}/person/count-invite-users Count persons in the organization available to invite as users #
GET /v2/org/{orgId}/person/group-by Find persons in the organization, grouped by an expression #
GET /v2/org/{orgId}/person/query-invite-users Find persons in the organization to invite as users #
GET /v2/org/{orgId}/person/subcounts Compute top-N + Other subcounts for one or more fields, for persons in the organization #
GET /v2/org/{orgId}/person/total Compute aggregated totals for persons matching a query #
GET /v2/org/{orgId}/person/{personId} Return a particular person by id #
PATCH /v2/org/{orgId}/person/{personId} Update a person #
DELETE /v2/org/{orgId}/person/{personId} Delete a person #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-person-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-person-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-person-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Person API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: person
paths:
  /v2/org/{orgId}/person:
    get:
      tags:
      - person
      summary: Find persons in the organization
      operationId: findPersons
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        description: Start date, if retrieving persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date, if retrieving persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: ids
        in: query
        description: Comma-separated list of person ids to look up
        required: false
        schema:
          type: string
      - name: from
        in: query
        description: Person 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: sort
        in: query
        description: Sort by fields, comma-separated. For descending sort, prepend a -
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Fields to retrieve, comma-separated
        required: false
        schema:
          type: string
      - name: fieldsList
        in: query
        description: Fields to retrieve, list syntax
        required: false
        schema:
          type: array
          items:
            type: string
      - name: includeAll
        in: query
        description: Include all persons in the system, including ex-employees or persons who were never in jobs
        required: false
        schema:
          type: boolean
      - name: format
        in: query
        description: Data format to use; default is json, can also use json-extended or json-readable
        required: false
        schema:
          type: string
      - name: splitColumns
        in: query
        description: Whether to split complex columns, used for tabular data formats
        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
      responses:
        '200':
          description: persons found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsData'
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - person
      summary: Create a person
      operationId: createPerson
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to create the person in
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of person creation
        required: false
        schema:
          type: string
          format: date
      responses:
        '201':
          description: person created
          content:
            application/json:
              schema:
                type: object
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
        required: true
  /v2/org/{orgId}/person/count:
    get:
      tags:
      - person
      summary: Count persons in an org
      operationId: countPersons
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        description: Start date, if counting persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date, if counting persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: includeAll
        in: query
        description: Include all persons in the system, including ex-employees or persons who were never in jobs
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgCount'
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/count-invite-users:
    get:
      tags:
      - person
      summary: Count persons in the organization available to invite as users
      operationId: countPersonsWithoutUser
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: isPreboarding
        in: query
        description: Whether you are searching for preboarding or activated users
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: count returned
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/group-by:
    get:
      tags:
      - person
      summary: Find persons in the organization, grouped by an expression
      operationId: findPersonsGrouped
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: startDate
        in: query
        description: Start date, if retrieving persons that existed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date, if retrieving persons that existed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: columns
        in: query
        description: Fields to retrieve with their aggregation function, comma-separated
        required: false
        schema:
          type: string
      - name: groupBy
        in: query
        description: Expression to group by
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort by fields, comma-separated. For descending sort, prepend a -
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: Data format to use; default is json, can also use json-extended or json-readable
        required: false
        schema:
          type: string
      - name: splitColumns
        in: query
        description: Whether to split complex columns, used for tabular data formats
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsData'
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/query-invite-users:
    get:
      tags:
      - person
      summary: Find persons in the organization to invite as users
      operationId: findPersonsWithoutUser
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: isPreboarding
        in: query
        description: Whether you are searching for preboarding or activated users
        required: false
        schema:
          type: boolean
      - name: from
        in: query
        description: Person 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: format
        in: query
        description: Data format to use; default is json, can also use json-extended or json-readable
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort field, prefix with - for descending (e.g. name, -name, startDate, -startDate)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: persons found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsData'
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/subcounts:
    get:
      tags:
      - person
      summary: Compute top-N + Other subcounts for one or more fields, for persons in the organization
      operationId: getPersonSubcounts
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        description: Start date, if counting persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date, if counting persons employed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Comma-separated list of fields to compute subcounts for
        required: true
        schema:
          type: string
      - name: topN
        in: query
        description: Number of top values to return per field; remainder is rolled into an Other bucket (default 10, max 25)
        required: false
        schema:
          type: integer
          format: int32
      - name: includeAll
        in: query
        description: Include all persons in the system, including ex-employees or persons who were never in jobs
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubcountsResponse'
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/total:
    get:
      tags:
      - person
      summary: Compute aggregated totals for persons matching a query
      operationId: getPersonTotals
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Date to search as of
        required: false
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        description: Start date, if retrieving persons that existed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date, if retrieving persons that existed between two dates (inclusive)
        required: false
        schema:
          type: string
          format: date
      - name: q
        in: query
        description: Search query
        required: false
        schema:
          type: string
      - name: includeAll
        in: query
        description: Include all persons in the system, including ex-employees or persons who were never in jobs
        required: false
        schema:
          type: boolean
      - name: columns
        in: query
        description: Fields to aggregate with their aggregation function, comma-separated
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
        '202':
          description: snapshot currently building
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/person/{personId}:
    get:
      tags:
      - person
      summary: Return a particular person by id
      operationId: getPerson
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: personId
        in: path
        description: Person id
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to query
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Date
        required: false
        schema:
          type: string
          format: date
      - name: fields
        in: query
        description: Fields to retrieve, comma-separated
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: Data format to use; default is json, can also use json-extended or json-readable
        required: false
        schema:
          type: string
      responses:
        '200':
          description: person found
          content:
            application/json:
              schema:
                type: object
        '400':
          description: bad request
        '404':
          description: not found
    patch:
      tags:
      - person
      summary: Update a person
      operationId: updatePerson
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: personId
        in: path
        description: Person id
        required: true
        schema:
          type: string
      - name: scenarioId
        in: query
        description: Scenario id to update the person in
        required: false
        schema:
          type: string
      - name: date
        in: query
        description: Effective date of person update
        required: false
        schema:
          type: string
          format: date
      responses:
        '204':
          description: no content
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
        required: true
    delete:
      tags:
      - person
      summary: Delete a person
      operationId: deletePerson
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: personId
        in: path
        description: Person id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: no content
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
components:
  schemas:
    SubcountsResponse:
      type: object
      required:
      - counts
      properties:
        counts:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FieldSubcount'
    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'
    FieldSubcount:
      type: object
      required:
      - count
      - isOther
      properties:
        key:
          type: object
        count:
          type: integer
          format: int64
        isOther:
          type: boolean
    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
    OrgCount:
      type: object
      required:
      - jobCount
      - personCount
      - startingCount
      - departingCount
      properties:
        jobCount:
          type: integer
          format: int64
        personCount:
          type: integer
          format: int64
        startingCount:
          type: integer
          format: int64
        departingCount:
          type: integer
          format: int64
        groupCount:
          type: integer
          format: int64
    ResultsData:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
        totalRow:
          type: object
          additionalProperties:
            type: object