How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Flatfile

Flatfile subpackage_guests API

The subpackage_guests API from Flatfile — 6 operation(s) for subpackage_guests.

Documentation Provider Profile APIs.io OpenAPI GitHub

Flatfile subpackage_guests API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 10 operations across 6 paths, and defines 33 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.x.flatfile.com/v1.

10 operations 6 paths 33 schemas 2 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.x.flatfile.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Flatfile subpackage_guests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_guests 10
GET
/guests
List guests
list 4 params → 200
POST
/guests
Create a guest
create 2 params body → 200
GET
/guests/{guestId}
Get a guest
get 3 params → 200
DELETE
/guests/{guestId}
Delete a guest
delete 4 params → 200
PATCH
/guests/{guestId}
Update a guest
update 3 params body → 200
GET
/guests/{guestId}/token
Get guest token
get-guest-token 4 params → 200
GET
/guests/{guestId}/roles
List Guest Roles
list-guest-roles 3 params → 200400403404
POST
/guests/{guestId}/roles
Assign Role to Guest
assign-guest-role 3 params body → 200400403404
DELETE
/guests/{guestId}/roles/{actorRoleId}
Remove Role from Guest
delete-guest-role 4 params → 200400403404
POST
/invitations
Invite guests
invite 2 params body → 200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are type_guests:Guest (7 properties), type_roles:AssignRoleResponseData (6 properties), type_roles:ActorRoleResponse (6 properties), type_guests:GuestSpace (4 properties). Each schema is shown below with its type and property counts.

type_commons:Success
object
Informs whether or not a request was successful
1 property
type_guests:GuestSheet
object
1 property 1 required
type_guests:GuestTokenResponse
object
1 property 1 required
type_commons:WorkbookId
string
Workbook ID
type_commons:SheetId
string
Sheet ID
type_roles:ActorRoleResponse
object
6 properties 6 required
type_guests:GuestWorkbook
object
1 property 1 required
type_commons:EnvironmentId
string
Environment ID
type_commons:Error
object
2 properties 1 required
type_commons:ActorRoleId
string
Actor Role ID
type_commons:RoleId
string
Role ID
type_guests:Guest
object
7 properties 7 required
type_commons:SuccessData
object
1 property 1 required
type_guests:GuestResponse
object
1 property 1 required
type_guests:GuestConfigUpdate
object
Properties used to update an existing guest
4 properties
type_commons:ActorIdUnion
type_guests:CreateGuestResponse
object
1 property 1 required
type_commons:GuestId
string
Guest ID
type_guests:Invite
object
4 properties 2 required
type_roles:AssignActorRoleRequest
object
2 properties 2 required
type_commons:Errors
object
1 property 1 required
type_commons:SpaceId
string
Space ID
type_commons:AgentId
string
Agent ID
type_guests:GuestSpace
object
4 properties 1 required
type_roles:AssignRoleResponse
object
1 property 1 required
type_roles:AssignRoleResponseData
object
6 properties 6 required
type_guests:ListGuestsResponse
object
1 property 1 required
type_commons:UserId
string
User ID
type_commons:AccountId
string
Account ID
type_roles:ListActorRolesResponse
object
1 property 1 required
type_roles:ResourceIdUnion
type_guests:GuestConfig
object
Configurations for the guests
4 properties 4 required
type_guests:GuestToken
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-guests-api-openapi.yml Raw ↑

Other APIs Flatfile publishes across the network.

Flatfile subpackage_accounts API
AE Profile APIs.io
Flatfile subpackage_actions API
AE Profile APIs.io
Flatfile subpackage_agent-exports API
AE Profile APIs.io
Flatfile subpackage_agents API
AE Profile APIs.io
Flatfile subpackage_apps API
AE Profile APIs.io
Flatfile subpackage_assistant API
AE Profile APIs.io
Flatfile subpackage_auth API
AE Profile APIs.io
Flatfile subpackage_canvas-areas API
AE Profile APIs.io
Flatfile subpackage_commits API
AE Profile APIs.io
Flatfile subpackage_data-clips API
AE Profile APIs.io
Flatfile subpackage_data-retention-policies API
AE Profile APIs.io
Flatfile subpackage_documents API
AE Profile APIs.io
← Back to F APIs
API Details
ID
flatfile:flatfile-subpackage-guests-api
Base URL
https://api.x.flatfile.com/v1
Docs
https://reference.flatfile.com/
Provider
Flatfile
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=flatfile-subpackage-guests-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/flatfile-subpackage-guests-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Flatfile subpackage_guests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.