> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stardex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List company activity types

> Returns every activity type registered for the requesting team — built-in types (e.g. `secondary_note`, `call_note`, `meeting_note`, `email`) and any custom types defined under Settings → Activity Types. No pagination — the full list is returned in a single response.

**When to use**: Call this before creating a company activity, or before filtering `GET /v1/company-activities` by `activity_types` / `excluded_activity_types`, so you know which keys are valid for the team.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/company-activities/types
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/company-activities/types:
    get:
      tags:
        - Company Activities
      summary: List company activity types
      description: >-
        Returns every activity type registered for the requesting team —
        built-in types (e.g. `secondary_note`, `call_note`, `meeting_note`,
        `email`) and any custom types defined under Settings → Activity Types.
        No pagination — the full list is returned in a single response.


        **When to use**: Call this before creating a company activity, or before
        filtering `GET /v1/company-activities` by `activity_types` /
        `excluded_activity_types`, so you know which keys are valid for the
        team.
      operationId: listCompanyActivityTypes
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
              - type: string
                enum:
                  - 'false'
              - type: boolean
          required: false
          name: include_archived
          in: query
      responses:
        '200':
          description: Company activity types fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCompanyActivityTypesResponse'
              example:
                success: true
                data:
                  - type: secondary_note
                    name: Note
                    protected: true
                    is_archived: false
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    ListCompanyActivityTypesResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompanyActivityTypeItem'
      required:
        - success
        - data
    CompanyActivityTypeItem:
      type: object
      properties:
        type:
          type: string
          description: >-
            Activity type key. Use this value as `activity_type` when creating
            company activities or filtering list responses.
        name:
          type: string
          description: Human-readable label for the activity type.
        protected:
          type: boolean
          description: True when the type is a built-in system type that cannot be deleted.
        is_archived:
          type: boolean
          description: >-
            True when the type has been hidden from the UI; archived types are
            excluded by default.
      required:
        - type
        - name
        - protected
        - is_archived
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````