Accoil

Accoil API

Accoil API as documented publicly: 17 operations. Contract generated from the documentation by API Evangelist (2026-10-26); not the provider's own document.

GitHub OpenAPI

Operations 17

POST / POST / #
GET /v1/accounts Legacy lookup of accounts (still supported) #
POST /v1/events POST /v1/events #
POST /v1/groups POST /v1/groups #
POST /v1/users Identify a user (legacy) #
GET /v2/accounts List accounts in a workspace, ranked by engagement score #
GET /v2/accounts/{id} Retrieve a single account with its full metric set #
POST /v2/group Associate a user with an account and set account traits #
POST /v2/identify Identify a user and set their traits #
GET /v2/segments List segments in a workspace #
GET /v2/segments/{id} Retrieve a single segment #
GET /v2/segments/{id}/members List the members of a segment #
POST /v2/track Record a user event #
GET /v2/users List users in a workspace, or look one up by email or tracking ID #
GET /v2/users/{id} Retrieve a single user with its full metric set #
GET /v2/workspaces List the workspaces your token can access #
GET /v2/workspaces/{id} Retrieve a single workspace #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/accoil/openapi/_ae-authored/accoil-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v2-workspaces-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v1-accounts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v2-accounts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v2-segments-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v2-segments-id-members-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/accoil/json-schema/accoil-get-v2-users-response-schema.json

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/accoil:accoil-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 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.

GitHub Google LinkedIn

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

OpenAPI Specification

accoil-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Accoil API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 17 operation(s) read from 19 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Accoil has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 14
    pages-with-code: 12
    pages-read: 19
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.accoil.com/docs/accoil-api
  - https://developer.accoil.com/docs/ingress-api
  - https://developer.accoil.com/docs/accoil-api/users
  - https://developer.accoil.com/docs/ingress-api/group
  - https://developer.accoil.com/docs/ingress-api/track
  - https://developer.accoil.com/docs/accoil-api/accounts
  - https://developer.accoil.com/docs/accoil-api/segments
  - https://developer.accoil.com/docs/ingress-api/identify
  - https://developer.accoil.com/docs/accoil-api/workspaces
  - https://developer.accoil.com/docs/ingress-api/legacy-v1/group
  - https://developer.accoil.com/docs/ingress-api/legacy-v1/track
  - https://developer.accoil.com/docs/accoil-api/legacy-v1/get-accounts
  - https://developer.accoil.com/docs/accoil-api/legacy-v1
  - https://developer.accoil.com/docs/quick-start/rest-api
  - https://developer.accoil.com/docs/ingress-api/legacy-v1
  - https://developer.accoil.com/docs/ingress-api/legacy-v1/identify
  - https://developer.accoil.com/docs/api-reference
  - https://developer.accoil.com/docs
  - https://developer.accoil.com
servers:
- url: https://in.accoil.com
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://developer.accoil.com/docs/quick-start/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl. Copy Markdown This guide walks you through the three core API calls -- identify, group, and track -- using curl against\
          \ the v2 REST API. \n Prerequisites You need an active Accoil account and an API key. Find your key under Account > General in the Accoil\
          \ dashboard. Each product has its own key. \n All requests go to https://in.accoil.com and return 202 Accepted . Processing happens\
          \ asynchrono"
  /v1/accounts:
    get:
      operationId: get_v1_accounts
      tags:
      - Accounts
      summary: Legacy lookup of accounts (still supported)
      x-source: https://developer.accoil.com/docs/accoil-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AccountsResponse'
      x-evidence:
        kind: documentation
  /v1/events:
    post:
      operationId: post_v1_events
      tags:
      - Events
      summary: POST /v1/events
      x-source: https://developer.accoil.com/docs/ingress-api/legacy-v1/track
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1EventsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Copy Text curl -X POST ''https://in.accoil.com/v1/events'' \ -H ''Content-Type: application/json'' \ -d ''{ "api_key":
          "f6ed0379283b149a2fd87a069d2b0d623c601272", "timestamp": 1500000000000, "user_id": "user_12345", "event": "Report_Created" }'' Example
          Response 202 Empty Group (v1) Legacy endpoint for group identification. Accoil API Read engagement scores, metrics, and insights back
          out of Accoil'
  /v1/groups:
    post:
      operationId: post_v1_groups
      tags:
      - Groups
      summary: POST /v1/groups
      x-source: https://developer.accoil.com/docs/ingress-api/legacy-v1/group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1GroupsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Copy Text curl -X POST ''https://in.accoil.com/v1/groups'' \ -H ''Content-Type: application/json'' \ -d ''{ "api_key":
          "f6ed0379283b149a2fd87a069d2b0d623c601272", "timestamp": 1500000000000, "group_id": "account_22" }'' Example Response 202 Empty Identify
          (v1) Legacy endpoint for user identification. Track (v1) Legacy endpoint for event tracking.'
  /v1/users:
    post:
      operationId: post_v1_users
      tags:
      - Users
      summary: Identify a user (legacy)
      x-source: https://developer.accoil.com/docs/ingress-api/legacy-v1
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/accounts:
    get:
      operationId: get_v2_accounts
      tags:
      - Accounts
      summary: List accounts in a workspace, ranked by engagement score
      x-source: https://developer.accoil.com/docs/accoil-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2AccountsResponse'
      x-evidence:
        kind: documentation
  /v2/accounts/{id}:
    get:
      operationId: get_v2_accounts_id
      tags:
      - Accounts
      summary: Retrieve a single account with its full metric set
      x-source: https://developer.accoil.com/docs/accoil-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2AccountsIdResponse'
      x-evidence:
        kind: documentation
  /v2/group:
    post:
      operationId: post_v2_group
      tags:
      - Group
      summary: Associate a user with an account and set account traits
      description: All ingress requests are processed asynchronously and return 202 Accepted.
      x-source: https://developer.accoil.com/docs/ingress-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/identify:
    post:
      operationId: post_v2_identify
      tags:
      - Identify
      summary: Identify a user and set their traits
      description: All ingress requests are processed asynchronously and return 202 Accepted.
      x-source: https://developer.accoil.com/docs/ingress-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/segments:
    get:
      operationId: get_v2_segments
      tags:
      - Segments
      summary: List segments in a workspace
      x-source: https://developer.accoil.com/docs/accoil-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2SegmentsResponse'
      x-evidence:
        kind: documentation
  /v2/segments/{id}:
    get:
      operationId: get_v2_segments_id
      tags:
      - Segments
      summary: Retrieve a single segment
      x-source: https://developer.accoil.com/docs/accoil-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2SegmentsIdResponse'
      x-evidence:
        kind: documentation
  /v2/segments/{id}/members:
    get:
      operationId: get_v2_segments_id_members
      tags:
      - Segments
      summary: List the members of a segment
      x-source: https://developer.accoil.com/docs/accoil-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2SegmentsIdMembersResponse'
      x-evidence:
        kind: documentation
  /v2/track:
    post:
      operationId: post_v2_track
      tags:
      - Track
      summary: Record a user event
      description: All ingress requests are processed asynchronously and return 202 Accepted.
      x-source: https://developer.accoil.com/docs/ingress-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/users:
    get:
      operationId: get_v2_users
      tags:
      - Users
      summary: List users in a workspace, or look one up by email or tracking ID
      x-source: https://developer.accoil.com/docs/accoil-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2UsersResponse'
      x-evidence:
        kind: documentation
  /v2/users/{id}:
    get:
      operationId: get_v2_users_id
      tags:
      - Users
      summary: Retrieve a single user with its full metric set
      x-source: https://developer.accoil.com/docs/accoil-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2UsersIdResponse'
      x-evidence:
        kind: documentation
  /v2/workspaces:
    get:
      operationId: get_v2_workspaces
      tags:
      - Workspaces
      summary: List the workspaces your token can access
      x-source: https://developer.accoil.com/docs/accoil-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2WorkspacesResponse'
      x-evidence:
        kind: documentation
  /v2/workspaces/{id}:
    get:
      operationId: get_v2_workspaces_id
      tags:
      - Workspaces
      summary: Retrieve a single workspace
      x-source: https://developer.accoil.com/docs/accoil-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2WorkspacesIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostRequest:
      type: object
      properties:
        userId:
          type: string
        traits:
          type: object
          properties:
            email:
              type: string
            name:
              type: string
            created_at:
              type: string
              format: date-time
    GetV1AccountsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of account objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    PostV1EventsRequest:
      type: object
      properties:
        api_key:
          type: string
        timestamp:
          type: integer
        user_id:
          type: string
        event:
          type: string
    PostV1GroupsRequest:
      type: object
      properties:
        api_key:
          type: string
        timestamp:
          type: integer
        group_id:
          type: string
    GetV2AccountsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of account objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    GetV2AccountsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Account object with metrics
        _meta:
          type: object
          description: Metadata
        _expansions:
          type: object
          description: Available expansions
    GetV2SegmentsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of segment objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    GetV2SegmentsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Segment object
        _meta:
          type: object
          description: Metadata
        _expansions:
          type: object
          description: Available expansions
    GetV2SegmentsIdMembersResponse:
      type: object
      properties:
        data:
          type: array
          description: List of member objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    GetV2UsersResponse:
      type: object
      properties:
        data:
          type: array
          description: List of user objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    GetV2UsersIdResponse:
      type: object
      properties:
        data:
          type: object
          description: User object with metrics
        _meta:
          type: object
          description: Metadata
        _expansions:
          type: object
          description: Available expansions
    GetV2WorkspacesResponse:
      type: object
      properties:
        data:
          type: array
          description: List of workspace objects
        _meta:
          type: object
          description: Pagination metadata
        _links:
          type: object
          description: Navigation links
        _expansions:
          type: object
          description: Available expansions
    GetV2WorkspacesIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Workspace object
        _meta:
          type: object
          description: Metadata
        _expansions:
          type: object
          description: Available expansions
  securitySchemes:
    basic:
      type: http
      scheme: basic
security:
- basic: []
tags:
- name: Accounts
- name: Api
- name: Events
- name: Group
- name: Groups
- name: Identify
- name: Segments
- name: Track
- name: Users
- name: Workspaces