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/scope-bid:scope-bid-partner-authorizations-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

openapi: 3.2.0
info:
  title: Scope Bid Partner Authorizations API
  version: 1.1.0
  description: 'Operations tagged Partner Authorizations across 2 of this provider''s published API definitions: scope-bid-openapi.json, scope-bid-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://scope.bid
  description: Production
security:
- bearerAuth: []
tags:
- name: Partner Authorizations
paths:
  /api/v1/partner-authorizations:
    post:
      summary: Firm grants a partner access on its behalf
      description: 'Firm accounts only: a partner acts on behalf of a firm, so a professional account cannot grant. The caller (session or PAT) needs users.manage or must be a firm admin. A partner token cannot manage grants.'
      responses:
        '201':
          description: Granted.
        '400':
          description: partner_id is missing, or is not a uuid. Nothing was granted.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: No partner with this partner_id. Nothing was granted.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          description: Database error. Nothing was granted.
        '503':
          description: 'Nothing was granted. With retryable: true, Scope could not confirm the account is a firm or the caller''s role at the firm; retry. With migration_pending: true, this deployment does not have the partner tables; retrying will not help.'
      tags:
      - Partner Authorizations
      operationId: postApiV1PartnerAuthorizations
      x-operation-id-source: derived
    get:
      summary: List this firm's partner grants
      responses:
        '200':
          description: Grants.
      tags:
      - Partner Authorizations
      operationId: getApiV1PartnerAuthorizations
      x-operation-id-source: derived
    delete:
      summary: Revoke a partner grant
      description: The caller (session or PAT) needs users.manage or must be a firm admin. A partner token cannot manage grants. Also deactivates that partner's webhook subscriptions for this firm. Revoking a grant that is already revoked answers 200.
      parameters:
      - name: partner_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Revoked.
        '400':
          description: partner_id is required.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: This firm has no grant to this partner (a partner_id that is not a uuid included). Nothing was revoked.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          description: Either a database error left the grant unchanged, or the grant WAS revoked but the partner's webhook subscriptions for this firm were not deactivated (deliveries to them stop anyway). The error text says which; retrying deactivates the subscriptions.
        '503':
          description: Scope could not confirm the caller's role at the firm. Nothing was revoked. Retry.
      tags:
      - Partner Authorizations
      operationId: deleteApiV1PartnerAuthorizations
      x-operation-id-source: derived
    servers:
    - url: https://scope.bid
      description: Production
components:
  responses:
    Forbidden:
      description: 'The caller is not authorized: the caller''s role does not grant the required capability, the partner token lacks the required scope, or the partner is not authorized to act for this firm.'
    Unauthorized:
      description: Missing or invalid access token.
    RateLimited:
      description: Per-tenant rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds until the window resets.
          schema:
            type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 access token, or a personal access token (PAT) for CI and power users. Pass as Authorization: Bearer <token>. Every token resolves to exactly one tenant.'
x-refined-from:
- scope-bid-openapi.json
- scope-bid-openapi.json