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/polytomic-subpackage-identity-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: Reference subpackage_bulkSync Subpackage Identity API
  version: 1.0.0
servers:
- url: https://app.polytomic.com
tags:
- name: subpackage_identity
paths:
  /api/me:
    get:
      operationId: get
      summary: Get Identity
      description: 'Returns information about the authenticated caller and, if applicable, the organization they are scoped to.


        Use this endpoint to confirm which kind of credential is being used before

        calling endpoints with stricter authorization rules.


        For user-scoped credentials, the response includes the resolved user and

        organization details. For non-user keys, the response identifies the key class

        with the corresponding boolean flags instead of impersonating a user.


        This endpoint is especially useful when debugging why a request is being

        accepted or rejected by endpoints that are limited to particular caller types.'
      tags:
      - subpackage_identity
      parameters:
      - name: X-Polytomic-Version
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdentityResponseEnvelope'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        key:
          type: string
        message:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        status:
          type: integer
      title: ApiError
    GetIdentityResponseSchema:
      type: object
      properties:
        email:
          type: string
          description: The email of the caller.
        id:
          type: string
          format: uuid
          description: The ID of the caller; this will be omitted for non-user callers.
        is_organization:
          type: boolean
          description: Whether the caller is using an organization key.
        is_partner:
          type: boolean
          description: Whether the caller is using a partner key.
        is_system:
          type: boolean
          description: Whether the caller is a system actor.
        is_user:
          type: boolean
          description: Whether the caller is a user.
        organization_id:
          type: string
          format: uuid
          description: The ID of the organization the caller belongs to.
        organization_name:
          type: string
          description: The name of the organization the caller belongs to.
        role:
          type: string
          description: Deprecated legacy role name. Populated only for user callers.
      title: GetIdentityResponseSchema
    GetIdentityResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetIdentityResponseSchema'
      title: GetIdentityResponseEnvelope
  securitySchemes:
    bearerUserAPIKey:
      type: http
      scheme: bearer
      description: Bearer user API key
    orgScopedAPIKey:
      type: http
      scheme: basic
      description: Basic organization-scoped API key
    bearerPartnerKey:
      type: http
      scheme: bearer
      description: Bearer partner API key