Search for commerce payments using specified criteria.

POST /crm/v3/objects/commerce_payments/search

Copy endpoint

https://api.hubapi.com

Execute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM.

Request Body

application/json required

interface PublicObjectSearchRequest {
after: string;
filterGroups:

FilterGroup

interface FilterGroup {
filters: Filter[];
}

[];
limit: number;
properties: string[];
query?: string;
sorts: string[];
}

Responses

200 application/json

successful operation

interface CollectionResponseWithTotalSimplePublicObject3 {
paging?:

Paging8

interface Paging8 {
next?: NextPage12;
prev?: PreviousPage;
}

;
results:

SimplePublicObject3

A simple public object.

interface SimplePublicObject3 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
objectWriteTraceId?: string;
properties: { };
propertiesWithHistory?: { };
updatedAt: string;
}

[];
total: number;
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}