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

Apideck Customers API

A Customer represents a buyer or client, including contact details, billing and shipping addresses, tax information, and payment terms.

Apideck Customers API is one of 54 APIs that Apideck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://unify.apideck.com.

5 operations 2 paths 61 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10.24.12
Base URL
https://unify.apideck.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

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

  • apiKey — To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the…

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.

Customers 5

A Customer represents a buyer or client, including contact details, billing and shipping addresses, tax information, and payment terms.

GET
/accounting/customers
Apideck List Customers
customersAll 11 params → 200400401402404422default
POST
/accounting/customers
Apideck Create Customer
customersAdd 5 params body → 201400401402404422default
GET
/accounting/customers/{id}
Apideck Get Customer
customersOne 7 params → 200400401402404422default
PATCH
/accounting/customers/{id}
Apideck Update Customer
customersUpdate 5 params body → 200400401402404422default
DELETE
/accounting/customers/{id}
Apideck Delete Customer
customersDelete 5 params → 200400401402404422default

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Customer (39 properties), Address (25 properties), BankAccount (12 properties), GetCustomersResponse (9 properties). Each schema is shown below with its type and property counts.

BankCode
stringnull
Bank code assigned by central bank
UnauthorizedResponse
object
6 properties
DownstreamId
stringnull
The third-party API ID of original entity
Address
object
25 properties
NotFoundResponse
object
6 properties
BankAccount
object
12 properties
GetCustomerResponse
object
7 properties 6 required
PaymentMethod
stringnull
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
DeleteCustomerResponse
object
7 properties 6 required
CreateCustomerResponse
object
7 properties 6 required
Channel
stringnull
The channel through which the transaction is processed.
FirstName
stringnull
The first name of the person.
BankName
stringnull
The name of the bank or financial institution
BankAccountName
stringnull
The name of the bank account
CustomersSort
object
2 properties
LinkedParentCustomer
objectnull
The parent customer this entity is linked to.
2 properties 1 required
CompanyName
stringnull
The name of the company.
UpdateCustomerResponse
object
7 properties 6 required
RoutingNumber
stringnull
Bank routing number (US)
UnexpectedErrorResponse
object
6 properties
UpdatedAt
stringnull
The date and time when the object was last updated.
Customer
object
39 properties 1 required
LinkedLedgerAccount
objectnull
6 properties
SortDirection
string
The direction in which to sort the results
Id
string
A unique identifier for an object.
Title
stringnull
The job title of the person.
BankAccountNumber
stringnull
The bank account number
Website
object
3 properties 1 required
Links
object
Links to navigate to previous or next pages through the API
3 properties
CustomersFilter
object
8 properties
Meta
object
Response metadata
2 properties
Country
stringnull
Country code according to ISO 3166-1 alpha-2.
TaxNumber
stringnull
CreatedAt
stringnull
The date and time when the object was created.
BIC
stringnull
Bank Identifier Code / SWIFT Code
BSBNumber
stringnull
Bank State Branch number (Australia/New Zealand)
PassThroughBody
array
The passthrough property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
PaymentRequiredResponse
object
6 properties
Taxable
booleannull
Whether the entity is subject to taxation
BranchIdentifier
stringnull
Bank branch identifier
IBAN
stringnull
International Bank Account Number
PassThroughQuery
object
1 property
UnprocessableResponse
object
6 properties
Currency
stringnull
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
RowVersion
stringnull
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
CustomMappings
objectnull
When custom mappings are configured on the resource, the result is included here.
AccountingCompanyId
stringnull
The company ID the transaction belongs to
Raw
objectnull
Raw response from the integration when raw=true query param is provided
CustomField
object
4 properties
CreatedBy
stringnull
The user who created the object.
LinkedTaxRate
object
4 properties
PhoneNumber
object
6 properties 1 required
MiddleName
stringnull
Middle name of the person.
TermsId
stringnull
The ID of the payment terms
UnifiedId
object
A object containing a unique identifier for the resource that was created, updated, or deleted.
1 property 1 required
GetCustomersResponse
object
9 properties 6 required
BadRequestResponse
object
7 properties
Suffix
stringnull
UpdatedBy
stringnull
The user who last updated the object.
Email
object
3 properties 1 required
LastName
stringnull
The last name of the person.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apideck-customers-api-openapi.yml Raw ↑

Other APIs Apideck publishes across the network.

Apideck Activities API
Apideck Aged Creditors API
Apideck Aged Debtors API
Apideck Attachments API
Apideck Balance Sheet API
Apideck Bank Accounts API
Apideck Bank Feed Accounts API
Apideck Bank Feed Statements API
Apideck Bill Payments API
Apideck Bills API
Apideck Categories API
Where this information came from

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