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

Buttondown Users API

The Users API from Buttondown — 5 operation(s) covering team members on the account and their permissions.

Buttondown Users API is one of 31 APIs that Buttondown publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 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.buttondown.com/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Buttondown Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key passed as 'Token ' in the Authorization header.

Paths & Operations 5

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

Users 5
POST
/users
Create User
create_user body → 201400403404409401429
GET
/users
List Users
list_users 1 param → 200403409401429
GET
/users/{id}
Retrieve User
retrieve_user 1 param → 200403404409401429
DELETE
/users/{id}
Delete User
delete_user 1 param → 204403404409401429
PATCH
/users/{id}
Update User
update_user 1 param body → 200400403404409401429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Permissions (8 properties), User (6 properties), UserPage (4 properties), ErrorMessage_Failure_ (3 properties). Each schema is shown below with its type and property counts.

UserInput
object
2 properties 2 required
AccessLevel
string
An enumeration.
User
object
6 properties 5 required
Permissions
object
8 properties
Failure
string
An enumeration.
ErrorMessage_Failure_
object
3 properties 1 required
UserUpdateInput
object
1 property 1 required
UserPage
object
4 properties 2 required
InvitationStatus
string
An enumeration.
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-users-api-openapi.yml Raw ↑

Other APIs Buttondown publishes across the network.

Buttondown Accounts API
Buttondown Advertising Units API
Buttondown API Requests API
Buttondown Attachments API
Buttondown Automations API
Buttondown Books API
Buttondown Bulk Actions API
Buttondown Comments API
Buttondown Coupons API
Buttondown Emails API
Buttondown Events API
Buttondown Exports API
Where this information came from

This is an independent, third-party profile of Buttondown 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.