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/cogram-com:cogram-com-project-types-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Cogram Project Types API
  description: 'API for integrating with Cogram. Every key is scoped to one organization.


    - **Auth**: `Authorization: Bearer `. Admins mint keys in Organization

    Settings → Integrations → API Keys.

    - **Pagination**: `page` (1-indexed) + `page_size` (default 50, max 100); returns

    `{"data": [...], "total": N, "page": N, "page_size": N}`. `total` = all matches.

    - **Errors**: `{"error": "", "message": ""}`. Branch on `error`; `message`

    wording may change.

    - **Rate limit**: per key, 1000 req/min by default. `429` carries `Retry-After`,

    `X-RateLimit-Limit`, `X-RateLimit-Remaining`.

    - **Attribution**: optional `X-Forwarded-User` header (≤200 chars) names the end user

    behind the call in Cogram''s audit trail.


    See API documentation for guides and examples.'
  version: v1
servers:
- url: /v1
tags:
- name: project-types
  description: Project-type taxonomy used to classify projects (e.g. "Design-Build").
paths:
  /project-types:
    get:
      tags:
      - project-types
      summary: List project types
      description: 'List project types in the organization.


        Returns a paginated list of project types along with the number of

        projects currently assigned to each type.'
      operationId: external_list_project_types_route_project_types_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed).
          default: 1
          title: Page
        description: Page number (1-indexed).
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTypeListV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
    post:
      tags:
      - project-types
      summary: Create project type
      description: 'Create a new project type.


        Project type names must be unique within the organization

        (case-insensitive).'
      operationId: external_create_project_type_route_project_types_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectTypeCreateV1'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTypeV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            application/json:
              example:
                error: conflict
                message: Resource already exists
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
  /project-types/{type_id}:
    get:
      tags:
      - project-types
      summary: Get project type
      description: Get a project type by ID.
      operationId: external_get_project_type_route_project_types__type_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: type_id
        in: path
        required: true
        schema:
          type: string
          title: Type Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTypeV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not found
          content:
            application/json:
              example:
                error: not_found
                message: Resource not found
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
    patch:
      tags:
      - project-types
      summary: Update project type
      description: 'Update a project type.


        Only provided fields are updated.'
      operationId: external_update_project_type_route_project_types__type_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: type_id
        in: path
        required: true
        schema:
          type: string
          title: Type Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectTypeUpdateV1'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTypeV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not found
          content:
            application/json:
              example:
                error: not_found
                message: Resource not found
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            application/json:
              example:
                error: conflict
                message: Resource already exists
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
    delete:
      tags:
      - project-types
      summary: Delete project type
      description: 'Delete a project type.


        Projects currently using this type will have their type cleared

        (foreign key SET NULL).'
      operationId: external_delete_project_type_route_project_types__type_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: type_id
        in: path
        required: true
        schema:
          type: string
          title: Type Id
      responses:
        '204':
          description: Successful Response
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not found
          content:
            application/json:
              example:
                error: not_found
                message: Resource not found
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
components:
  schemas:
    ProjectTypeV1:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        color:
          anyOf:
          - type: string
          - type: 'null'
          title: Color
        projects_count:
          type: integer
          title: Projects Count
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Null if never updated.
      type: object
      required:
      - id
      - name
      - color
      - projects_count
      - created_at
      - updated_at
      title: ProjectTypeV1
      description: Project-type response.
    ProjectTypeListV1:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ProjectTypeV1'
          type: array
          title: Data
        total:
          type: integer
          title: Total
          description: Total matches across all pages, not just this page.
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
      type: object
      required:
      - data
      - total
      - page
      - page_size
      title: ProjectTypeListV1
      description: Paginated project-type list response.
    ProjectTypeUpdateV1:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Name
          description: Unique within the org (case-insensitive).
        color:
          anyOf:
          - type: string
          - type: 'null'
          title: Color
          description: Optional hex color for UI display, e.g. '#3B82F6'.
      type: object
      title: ProjectTypeUpdateV1
      description: 'Update project-type request.


        All fields are optional - only provided fields will be updated.'
    ErrorCode:
      type: string
      enum:
      - api_key_missing
      - api_key_invalid_format
      - api_key_invalid
      - api_key_expired
      - bad_request
      - forbidden
      - not_found
      - method_not_allowed
      - conflict
      - validation_error
      - rate_limit_exceeded
      - internal_error
      - range_too_large
      - data_export_in_progress
      title: ErrorCode
      description: Error codes for external API v1.
    ErrorV1:
      properties:
        error:
          $ref: '#/components/schemas/ErrorCode'
          description: Stable machine-readable code. Branch on this.
        message:
          type: string
          title: Message
          description: Human-readable detail. Wording may change.
      type: object
      required:
      - error
      - message
      title: ErrorV1
      description: 'JSON body format for all API v1 error responses.


        This model controls the actual serialization of error responses:

        {"error": "not_found", "message": "Project ''xyz'' not found"}'
    ProjectTypeCreateV1:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
          description: Unique within the org (case-insensitive).
        color:
          anyOf:
          - type: string
          - type: 'null'
          title: Color
          description: Optional hex color for UI display, e.g. '#3B82F6'.
      type: object
      required:
      - name
      title: ProjectTypeCreateV1
      description: Create project-type request.
  securitySchemes:
    HTTPBearer:
      type: http
      description: Organization API key. Minted by admins in Organization Settings → Integrations → API Keys; shown once, may carry an expiry.
      scheme: bearer
      bearerFormat: Cogram organization API key