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 Users API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Flatfile Subpackage Users 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 9 operations across 6 paths, and defines 28 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.

9 operations 6 paths 28 schemas 2 DELETE3 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 Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 9

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

subpackage_users 9
GET
/users
List users
list 8 params → 200
POST
/users/invite
Create and Invite User
create-and-invite 2 params body → 200
POST
/users/{userId}/resend-invite
Resend User Invite
resend-invite 3 params → 200
PATCH
/users/{userId}
Update a user
update 3 params body → 200
GET
/users/{userId}
Get a user
get 3 params → 200
DELETE
/users/{userId}
Delete a user
delete 3 params → 200
GET
/users/{userId}/roles
List User Roles
list-user-roles 3 params → 200400403404
POST
/users/{userId}/roles
Assign Role to User
assign-user-role 3 params body → 200400403404
DELETE
/users/{userId}/roles/{actorRoleId}
Remove Role from User
delete-user-role 4 params → 200400403404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are type_users_UserWithRoles (12 properties), type_users_User (11 properties), type_roles_ActorRoleResponse (6 properties), type_roles_AssignRoleResponseData (6 properties). Each schema is shown below with its type and property counts.

type_users_User
object
Configurations for the user
11 properties 8 required
type_commons_ActorRoleId
string
Actor Role ID
type_roles_AssignRoleResponseData
object
6 properties 6 required
type_users_ListUsersResponse
object
2 properties 1 required
type_users_UserWithRolesResponse
object
1 property 1 required
type_roles_ActorRoleResponse
object
6 properties 6 required
type_commons_SuccessData
object
1 property 1 required
type_users_UserCreateAndInviteRequest
object
Properties used to create a new user
3 properties 3 required
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_commons_RoleId
string
Role ID
type_commons_AgentId
string
Agent ID
type_commons_SortDirection
string
Sort direction - asc (ascending) or desc (descending)
type_users_UserWithRoles
object
12 properties 9 required
type_commons_AccountId
string
Account ID
type_roles_ResourceIdUnion
type_commons_EnvironmentId
string
Environment ID
type_roles_AssignActorRoleRequest
object
2 properties 2 required
type_users_ListUsersSortField
string
type_commons_SpaceId
string
Space ID
type_roles_ListActorRolesResponse
object
1 property 1 required
type_commons_Errors
object
1 property 1 required
type_users_UserResponse
object
1 property 1 required
type_commons_Pagination
object
pagination info
3 properties 3 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-users-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-users-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-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/flatfile-subpackage-users-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 Users 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.