Flatfile subpackage_auth API
The subpackage_auth API from Flatfile — 2 operation(s) for subpackage_auth.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flatfile-subpackage-auth-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference subpackage_accounts Subpackage Auth API
version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_auth
paths:
/auth/publishable-key:
get:
operationId: get-publishable-key
summary: Obtain the publishable key for a specific environment
tags:
- subpackage_auth
parameters:
- name: environmentId
in: query
description: ID of environment to search
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_auth_PublishableKeyResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/auth/sftp-credentials:
get:
operationId: get-sftp-credentials
summary: Get SFTP credentials for Space
tags:
- subpackage_auth
parameters:
- name: spaceId
in: query
description: ID of space to get credentials for
required: true
schema:
$ref: '#/components/schemas/type_commons_SpaceId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_auth_SftpCredentials'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
components:
schemas:
type_auth_PublishableKeyResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_auth_ApiKey'
required:
- data
title: PublishableKeyResponse
type_commons_Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/type_commons_Error'
required:
- errors
title: Errors
type_auth_RawKey:
type: string
description: Raw Api Key
title: RawKey
type_commons_SpaceId:
type: string
description: Space ID
title: SpaceId
type_auth_ApiKeyOperation:
type: object
properties:
path:
type: string
method:
type: string
required:
- path
- method
title: ApiKeyOperation
type_commons_Error:
type: object
properties:
key:
type: string
message:
type: string
required:
- message
title: Error
type_auth_ApiKey:
type: object
properties:
id:
$ref: '#/components/schemas/type_auth_ApiKeyId'
rawKey:
$ref: '#/components/schemas/type_auth_RawKey'
type:
$ref: '#/components/schemas/type_auth_ApiKeyType'
environmentId:
$ref: '#/components/schemas/type_commons_EnvironmentId'
accountId:
$ref: '#/components/schemas/type_commons_AccountId'
operations:
type: array
items:
$ref: '#/components/schemas/type_auth_ApiKeyOperation'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
deletedAt:
type: string
format: date-time
secret:
type: string
required:
- id
- type
- operations
- createdAt
description: API Key used for authenticating against our APIs
title: ApiKey
type_auth_ApiKeyType:
type: string
enum:
- PUBLISHABLE
- SECRET
title: ApiKeyType
type_commons_AccountId:
type: string
description: Account ID
title: AccountId
type_auth_ApiKeyId:
type: string
description: Api Key ID
title: ApiKeyId
type_auth_SftpCredentials:
type: object
properties:
username:
type: string
password:
type: string
host:
type: string
port:
type: string
required:
- username
- password
- host
- port
description: Credentials being used to login to SFTP with host and port
title: SftpCredentials
type_commons_EnvironmentId:
type: string
description: Environment ID
title: EnvironmentId
securitySchemes:
default:
type: http
scheme: bearer