Bitly

Bitly Organizations API

Read organizations, their plan limits, and shorten counts overall and by group. 5 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organizations List my organizations · Retrieve Organizations #
Ask an LLM
“Which Bitly organizations do I belong to?”
“Can I see organizations my token is not scoped to as well?”
Tell an agent
List the organizations my token can access.
List all of my organizations, including ones outside the token's allowed orgs, with include_all set to {include_all}.
GET /organizations/{organization_guid} Get an organization's details · Retrieve an Organization #
Ask an LLM
“How do I look up the details of one organization by its GUID?”
“What tier and name does a particular organization have?”
Tell an agent
Show the details of organization {organization_guid}.
Fetch organization {organization_guid}.
GET /organizations/{organization_guid}/shorten_counts Count links shortened by an organization over time · Get Shorten Counts for an Organization #
Ask an LLM
“How many links has my whole organization shortened over the last few months?”
“Can I see an organization's shortening volume broken out by day or week?”
Tell an agent
Show how many links organization {organization_guid} shortened over the last {units} {unit}s.
Get organization {organization_guid}'s shorten counts per {unit} for all time.
GET /organizations/{organization_guid}/shorten_counts_by_group Break down an organization's shortens by group this month · Get Shorten Counts for an Organization by Group #
Ask an LLM
“Which groups in my organization are shortening the most links this month?”
“Can I split this month's organization shorten count across its groups?”
Tell an agent
Break down this month's shortened links for organization {organization_guid} by group.
Show per-group shorten counts for the current month in organization {organization_guid}.
GET /organizations/{organization_guid}/plan_limits Check an organization's plan limits · Get Plan Limits #
Ask an LLM
“How close is my organization to its plan's link and QR code limits?”
“What does our subscription plan allow, and how much of it have we used?”
Tell an agent
Show the plan limits and current counts for organization {organization_guid}.
Check how much of its plan allowance organization {organization_guid} has used.

Documentation

📖
Documentation
https://dev.bitly.com/api-reference
📖
APIReference
https://dev.bitly.com/api-reference
📖
GettingStarted
https://dev.bitly.com/docs/getting-started/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/openapi/bitly-organizations-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-organizations-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-organizations-api.opencollection.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/overlays/bitly-organizations-overlay.yaml

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/bitly:bitly-organizations-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

bitly-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 4.0.0
  title: Bitly Organizations API
  termsOfService: https://bitly.com/pages/terms-of-service
  contact:
    url: https://bitly.is/API-support
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: /v4/header-logo.png
  description: Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization.
servers:
- url: https://api-ssl.bitly.com/v4
security:
- bearerAuth: []
tags:
- name: Organizations
  description: Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization.
paths:
  /organizations:
    get:
      summary: Retrieve Organizations
      description: Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token's allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured.
      tags:
      - Organizations
      operationId: getOrganizations
      parameters:
      - name: include_all
        in: query
        required: false
        description: 'When set to true, returns all of the user''s organizations regardless of the token''s allowed_orgs restrictions.

          '
        schema:
          type: boolean
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organizations'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /organizations/{organization_guid}:
    get:
      summary: Retrieve an Organization
      description: Retrive details for the specified organization.
      tags:
      - Organizations
      operationId: getOrganization
      parameters:
      - $ref: '#/components/parameters/OrganizationGUID'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /organizations/{organization_guid}/shorten_counts:
    get:
      description: Returns the shorten counts for a specific organization over a specified time period.
      summary: Get Shorten Counts for an Organization
      operationId: getOrganizationShortenCounts
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrganizationGUID'
      - $ref: '#/components/parameters/TimeUnit'
      - $ref: '#/components/parameters/UnitAmount'
      - $ref: '#/components/parameters/UnitReferenceTimeStamp'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metrics'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /organizations/{organization_guid}/shorten_counts_by_group:
    get:
      description: Returns the shorten counts for a specific organization by group for the current month.
      summary: Get Shorten Counts for an Organization by Group
      operationId: getOrganizationShortenCountsByGroup
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrganizationGUID'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metrics'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /organizations/{organization_guid}/plan_limits:
    get:
      summary: Get Plan Limits
      description: Returns all plan limits and counts available for an organization.
      operationId: getPlanLimits
      parameters:
      - $ref: '#/components/parameters/OrganizationGUID'
      tags:
      - Organizations
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanLimits'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
components:
  schemas:
    Organizations:
      type: object
      required:
      - organizations
      properties:
        organizations:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
    PlanLimits:
      type: object
      allOf:
      - $ref: '#/components/schemas/HasReferences'
      - properties:
          organization_guid:
            type: string
          plan_limits:
            type: array
            items:
              $ref: '#/components/schemas/PlanLimit'
    Metric:
      type: object
      properties:
        key:
          type: string
        value:
          type: integer
    InternalError:
      description: INTERNAL_ERROR
      allOf:
      - $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        message:
          type: string
        description:
          type: string
        resource:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    Forbidden:
      description: FORBIDDEN
      allOf:
      - $ref: '#/components/schemas/Error'
    NotFound:
      description: NOT_FOUND
      allOf:
      - $ref: '#/components/schemas/Error'
    Metrics:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseMetrics'
      - properties:
          metrics:
            type: array
            items:
              $ref: '#/components/schemas/Metric'
    FieldError:
      type: object
      properties:
        field:
          type: string
        error_code:
          type: string
        message:
          type: string
    TemporarilyUnavailable:
      description: TEMPORARILY_UNAVAILABLE
      allOf:
      - $ref: '#/components/schemas/Error'
    PlanLimit:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        limit:
          type: integer
        count:
          type: integer
    Organization:
      type: object
      required:
      - guid
      - name
      - is_active
      - tier
      - tier_family
      - tier_display_name
      - role
      - created
      - modified
      - bsds
      allOf:
      - $ref: '#/components/schemas/HasReferences'
      - properties:
          name:
            type: string
          is_active:
            type: boolean
          guid:
            type: string
          tier:
            type: string
          tier_family:
            type: string
          tier_display_name:
            type: string
          role:
            type: string
          created:
            type: string
          modified:
            type: string
          bsds:
            type: array
            items:
              type: string
          require_sso:
            type: string
            description: 'SSO authentication requirement for this organization. Possible values: "none", "any". Omitted when no auth requirements are configured.

              '
            enum:
            - none
            - any
          require_2fa:
            type: string
            description: 'Two-factor authentication requirement for this organization. Possible values: "none", "sms". Omitted when no auth requirements are configured.

              '
            enum:
            - none
            - sms
    HasReferences:
      type: object
      properties:
        references:
          type: object
          additionalProperties:
            type: string
    TimeUnit:
      description: the unit of time queried for (minute, hour, day, week, month)
      type: string
      enum:
      - minute
      - hour
      - day
      - week
      - month
      default: day
    BaseMetrics:
      type: object
      properties:
        unit:
          type: string
          x-faker: internet.userName
        units:
          type: integer
          x-faker:
            datatype.number:
              min: 1
              max: 100
        facet:
          type: string
          enum:
          - countries
          - cities
          - devices
          - referrers
          - referrers_by_domain
          - referring_domains
          - referring_networks
          - shorten_counts
          - destinations
        unit_reference:
          type: string
          x-faker: date.past
  parameters:
    OrganizationGUID:
      name: organization_guid
      description: A GUID for a Bitly organization
      in: path
      required: true
      schema:
        type: string
      example: Oa1bcd234eF
    UnitReferenceTimeStamp:
      name: unit_reference
      description: An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
      schema:
        type: string
      required: false
      in: query
      example: 2006-01-02T15:04:05-0700
    UnitAmount:
      name: units
      description: An integer representing the time units to query data for. pass -1 to return all units of time
      schema:
        type: integer
        default: -1
      required: true
      in: query
      example: 1
    TimeUnit:
      name: unit
      description: A unit of time
      schema:
        $ref: '#/components/schemas/TimeUnit'
      required: true
      in: query
      example: month
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer