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

Flatfile Subpackage Guests API

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

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.2.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.2.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_GuestConfig (4 properties). Each schema is shown below with its type and property counts.

type_commons_WorkbookId
string
Workbook ID
type_commons_ActorRoleId
string
Actor Role ID
type_roles_AssignRoleResponseData
object
6 properties 6 required
type_guests_Invite
object
4 properties 2 required
type_commons_SheetId
string
Sheet ID
type_guests_ListGuestsResponse
object
1 property 1 required
type_roles_ActorRoleResponse
object
6 properties 6 required
type_commons_SuccessData
object
1 property 1 required
type_guests_GuestConfigUpdate
object
Properties used to update an existing guest
4 properties
type_commons_GuestId
string
Guest ID
type_roles_AssignRoleResponse
object
1 property 1 required
type_commons_Success
object
Informs whether or not a request was successful
1 property
type_commons_UserId
string
User ID
type_guests_GuestWorkbook
object
1 property 1 required
type_guests_GuestConfig
object
Configurations for the guests
4 properties 4 required
type_commons_RoleId
string
Role ID
type_commons_AgentId
string
Agent ID
type_guests_GuestToken
object
2 properties 2 required
type_commons_AccountId
string
Account ID
type_roles_ResourceIdUnion
type_guests_GuestSpace
object
4 properties 1 required
type_commons_EnvironmentId
string
Environment ID
type_roles_AssignActorRoleRequest
object
2 properties 2 required
type_guests_GuestSheet
object
1 property 1 required
type_guests_GuestResponse
object
1 property 1 required
type_commons_SpaceId
string
Space ID
type_roles_ListActorRolesResponse
object
1 property 1 required
type_guests_Guest
object
7 properties 7 required
type_commons_Errors
object
1 property 1 required
type_guests_CreateGuestResponse
object
1 property 1 required
type_guests_GuestTokenResponse
object
1 property 1 required
type_commons_Error
object
2 properties 1 required
type_commons_ActorIdUnion

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
Flatfile Subpackage Actions API
Flatfile Subpackage Agent Exports API
Flatfile Subpackage Agents API
Flatfile Subpackage Apps API
Flatfile Subpackage Assistant API
Flatfile Subpackage Auth API
Flatfile Subpackage Canvas Areas API
Flatfile Subpackage Commits API
Flatfile Subpackage Data Clips API
Flatfile Subpackage Data Retention Policies API
Flatfile Subpackage Documents API
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.