Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Abound Users API

The Users API from Abound — 2 operation(s) for users.

Abound Users API is one of 13 APIs that Abound publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

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

Requests are made against 2 base URLs: https://production-api.withabound.com, https://sandbox-api.withabound.com.

4 operations 2 paths 10 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4
Base URL
https://production-api.withabound.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Abound Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token. The token is the concatenation of your Abound appId and appSecret separated by a period, e.g. appIdxxx.appSecretyyy.

Paths & Operations 4

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

Users 4
GET
/v4/users
List all users
usersList 3 params → 200400401404500
POST
/v4/users
Create a user
usersCreate 1 param body → 200400401404409500
GET
/v4/users/{userId}
Retrieve a user
usersRetrieve 1 param → 200400401404500
PUT
/v4/users/{userId}
Update a user
usersUpdate 1 param body → 200400401404409

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are UserRequestSchema (3 properties), ErrorBadRequestSchemaErrorsItem (2 properties), ErrorBadRequestSchema (1 property), DefaultErrorSchema (1 property). Each schema is shown below with its type and property counts.

Email
string
Filters the list of users based on the email field.
UserId
string
The unique identifier for a single end-user of your application.
Page
integer
The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
DefaultErrorSchema
object
1 property 1 required
IdempotencyKey
string
The unique key used to identify a request that has already been processed.
ForeignId
string
The customer-specific unique identifier associated to an Abound record. Allows developers to forego making their own tables every time they integrate and/or ad…
UserRequestSchema
object
3 properties
ErrorBadRequestSchema
object
1 property 1 required
ErrorBadRequestSchemaErrorsItem
object
2 properties 1 required
UserSchema

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abound-users-api-openapi.yml Raw ↑

Other APIs Abound publishes across the network.

Abound 1099-INT API
Abound 1099-K API
Abound 1099-MISC API
Abound 1099-NEC API
Abound Access Tokens API
Abound Electronic Delivery Consents API
Abound Mailings API
Abound Tax Treaties API
Abound TIN Verifications API
Abound W-8BEN API
Abound W-8BEN-E API
Abound W-9 API