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
GetPaid

GetPaid Queries API

List resources filtering and sorting them as needed.

Documentation Provider Profile APIs.io OpenAPI GitHub

GetPaid Queries API is one of 6 APIs that GetPaid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 46 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.getpaid.io, https://api.sandbox.getpaid.io.

1 operations 1 paths 46 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.getpaid.io
Authentication
OAuth 2.0
Contact
support@getpaid.io
Resource Areas
1

Authentication & Security 1

GetPaid Queries API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth) using the clientCredentials flow, exposing 4 scopes.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Queries 1

List resources filtering and sorting them as needed.

POST
/v2/{resource_type}/query
Query resources
query_resources 1 param body → 200400401422429500

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are BaseQueryRequest (5 properties), PaymentsFiltersRequest (4 properties), ProblemDetailsBase (4 properties), CheckoutsFiltersRequest (4 properties). Each schema is shown below with its type and property counts.

PaymentId
PaymentMethodBase
object
1 property 1 required
QueryPaymentsResponse
BasePaymentMethodHint
Reference
QueryPaymentMethodHint
object
The payment method used in a checkout.
2 properties 1 required
PaginationData
array
The list of queried elements.
AccountId
QueriesResourceType
string
The type of the Getpaid solution resources to get analytics from: - checkouts - payments
QueryResourcesResponse
Currency
string
The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO4217)
PaymentMethodDisplayHint
MediumString
string
PaginationFirst
integer
Pagination. The number of elements that will be retrieved.
AmountMinor
integer
The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
CheckoutsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
PaymentMethodType
string
The type of payment method.
QueryCheckoutsRequest
AccountLegalName
DateTime
string
UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
PaginatedResponse
object
2 properties 1 required
QueryCheckoutsResponse
QueryPaymentsRequest
CheckoutStatus
string
The status of the checkout. See the [list, transitions, and description of each status](/payments/checkoutslifecycle) for more details.
BaseQueryRequest
object
5 properties
PartyRef
object
A reference to a party account involved in the transaction.
3 properties 3 required
CreatedAt
PaginationCursor
string
The cursor to the last item. If non-empty, can be used to fetch the next page. If not set, there is no more elements.
UpdatedAt
PaymentsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
PaginationAfter
string
Pagination. The cursor from next page will be retrieved.
CardScheme
string
The card scheme.
Id
string
CardPaymentMethodHint
BaseSortItemRequest
object
Each field to sort by.
2 properties 2 required
ShortString
string
CheckoutExpiresAt
PaymentMethodHint
The payment method used.
PaymentsFiltersRequest
object
Filtering payments.
4 properties
ProblemDetailsBase
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
4 properties 3 required
SellerRef
object
A reference to the seller account.
2 properties 2 required
CheckoutsFiltersRequest
object
Filtering checkouts.
4 properties
CheckoutId
BaseSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
PaymentStatus
string
The status of the payment. See the [list, transitions, and description of each status](/payments/lifecycle) for more details.
QueryResourcesRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getpaid-queries-api-openapi.yml Raw ↑

Other APIs GetPaid publishes across the network.

GetPaid Accounts API
AE Profile APIs.io
GetPaid Applications API
AE Profile APIs.io
GetPaid Authentication API
AE Profile APIs.io
GetPaid Checkouts API
AE Profile APIs.io
GetPaid Payments API
AE Profile APIs.io
#Query
← Back to G APIs
API Details
ID
getpaid:getpaid-queries-api
Base URL
https://api.getpaid.io
Docs
https://docs.getpaid.io/api
Provider
GetPaid
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=getpaid-queries-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/getpaid-queries-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 GetPaid Queries 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.