CodeQR Projects API

The Projects API from CodeQR — 2 operation(s) for projects.

GitHub OpenAPI

Operations 2

GET /projects Retrieve a list of projects #
GET /projects/{projectSlug} Retrieve a project #

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/codeqr-io:codeqr-io-projects-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.

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

OpenAPI Specification

codeqr-io-projects-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Codeqr Io Projects API
  version: 0.0.1
  contact:
    name: CodeQR.io Support
    email: contact@codeqr.io
    url: https://codeqr.io/api
  license:
    name: AGPL-3.0 license
  description: 'Operations tagged Projects across 2 of this provider''s published API definitions: codeqr-io-openapi.documented.yml, codeqr-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.codeqr.io
  description: Production API
tags:
- name: Projects
paths:
  /projects:
    get:
      operationId: getProjects
      summary: Retrieve a list of projects
      description: Retrieve a list of projects for the authenticated user.
      tags:
      - Projects
      security:
      - token: []
      responses:
        '200':
          description: A list of projects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProjectSchema'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '410':
          $ref: '#/components/responses/410'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      x-codeSamples:
      - lang: JavaScript
        source: "import CodeQR from '@codeqr/ts';\n\nconst client = new CodeQR({\n  apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted\n});\n\nconst projects = await client.projects.list();\n\nconsole.log(projects);"
    servers:
    - url: https://api.codeqr.io
      description: Production API
  /projects/{projectSlug}:
    get:
      operationId: getProject
      summary: Retrieve a project
      description: Retrieve a project for the authenticated user.
      tags:
      - Projects
      security:
      - token: []
      parameters:
      - in: path
        name: projectSlug
        description: The slug for the project to retrieve. E.g. for `app.codeqr.io/acme`, the projectSlug is `acme`.
        schema:
          type: string
          description: The slug for the project to retrieve. E.g. for `app.codeqr.io/acme`, the projectSlug is `acme`.
        required: true
      responses:
        '200':
          description: The retrieved project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSchema'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '410':
          $ref: '#/components/responses/410'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://api.codeqr.io
      description: Production API
components:
  responses:
    '400':
      description: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
      content:
        application/json:
          schema:
            x-speakeasy-name-override: BadRequest
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - bad_request
                    description: A short code indicating the error code returned.
                    example: bad_request
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#bad-request
                required:
                - code
                - message
            required:
            - error
    '500':
      description: The server has encountered a situation it does not know how to handle.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: InternalServerError
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - internal_server_error
                    description: A short code indicating the error code returned.
                    example: internal_server_error
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#internal-server_error
                required:
                - code
                - message
            required:
            - error
    '403':
      description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Forbidden
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - forbidden
                    description: A short code indicating the error code returned.
                    example: forbidden
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#forbidden
                required:
                - code
                - message
            required:
            - error
    '409':
      description: This response is sent when a request conflicts with the current state of the server.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Conflict
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - conflict
                    description: A short code indicating the error code returned.
                    example: conflict
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#conflict
                required:
                - code
                - message
            required:
            - error
    '429':
      description: The user has sent too many requests in a given amount of time ("rate limiting")
      content:
        application/json:
          schema:
            x-speakeasy-name-override: RateLimitExceeded
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - rate_limit_exceeded
                    description: A short code indicating the error code returned.
                    example: rate_limit_exceeded
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#rate-limit_exceeded
                required:
                - code
                - message
            required:
            - error
    '401':
      description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Unauthorized
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - unauthorized
                    description: A short code indicating the error code returned.
                    example: unauthorized
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#unauthorized
                required:
                - code
                - message
            required:
            - error
    '404':
      description: The server cannot find the requested resource.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: NotFound
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - not_found
                    description: A short code indicating the error code returned.
                    example: not_found
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#not-found
                required:
                - code
                - message
            required:
            - error
    '422':
      description: The request was well-formed but was unable to be followed due to semantic errors.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: UnprocessableEntity
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - unprocessable_entity
                    description: A short code indicating the error code returned.
                    example: unprocessable_entity
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#unprocessable-entity
                required:
                - code
                - message
            required:
            - error
    '410':
      description: This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: InviteExpired
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - invite_expired
                    description: A short code indicating the error code returned.
                    example: invite_expired
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: A link to our documentation with more details about this error code
                    example: https://docs.codeqr.io/api-reference/errors#invite-expired
                required:
                - code
                - message
            required:
            - error
  schemas:
    ProjectSchema:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the project.
        name:
          type: string
          description: The name of the project.
        slug:
          type: string
          description: The slug of the project.
        logo:
          type:
          - string
          - 'null'
          default: null
          description: The logo of the project.
        usage:
          type: number
          description: The usage of the project.
        usageLimit:
          type: number
          description: The usage limit of the project.
        linksUsage:
          type: number
          description: The links usage of the project.
        linksLimit:
          type: number
          description: The links limit of the project.
        domainsLimit:
          type: number
          description: The domains limit of the project.
        tagsLimit:
          type: number
          description: The tags limit of the project.
        usersLimit:
          type: number
          description: The users limit of the project.
        plan:
          type: string
          enum:
          - free
          - starter
          - pro
          - business
          - scale
          - enterprise
          description: The plan of the project.
        stripeId:
          type:
          - string
          - 'null'
          description: The Stripe ID of the project.
        billingCycleStart:
          type: number
          description: The date and time when the billing cycle starts for the project.
        stripeConnectId:
          type:
          - string
          - 'null'
          description: '[BETA]: The Stripe Connect ID of the project.'
        createdAt:
          type: string
          description: The date and time when the project was created.
        users:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                enum:
                - owner
                - member
                description: The role of the authenticated user in the project.
            required:
            - role
          description: The role of the authenticated user in the project.
        domains:
          type: array
          items:
            type: object
            properties:
              slug:
                type: string
                description: The domain of the project.
            required:
            - slug
          description: The domains of the project.
        metadata:
          type: object
          properties:
            defaultDomains:
              type: array
              items:
                type: string
          required:
          - defaultDomains
      required:
      - id
      - name
      - slug
      - logo
      - usage
      - usageLimit
      - linksUsage
      - linksLimit
      - domainsLimit
      - tagsLimit
      - usersLimit
      - plan
      - stripeId
      - billingCycleStart
      - stripeConnectId
      - createdAt
      - users
      - domains
      - metadata
      title: Project
  securitySchemes:
    token:
      type: http
      description: Default authentication mechanism
      scheme: bearer
x-refined-from:
- codeqr-io-openapi.documented.yml
- codeqr-io-openapi.yml