Query data from a custom object dataset

post https://custom-objects-service.aorpeks.act-on.net/v1/{accountId}/query/{objectId}/{datasetId}/joinWithOther

Performs a query on custom object data with a simple join with Account Object Context

Path Params

accountId

string

required

Account ID

objectId

string

required

The Custom Object Schema Id for this request

datasetId

string

required

The Custom Object Dataset Id for this request

Query Params

mode

string

The query mode parameter (optional)

Body Params

otherObject

string

Locator of the other data source to join with.

otherDataset

string

Optional locator (id, name) of the other data source dataset (if Custom Object) to join with.

selectFields

array of strings

length between 0 and 2000

List of fields to select. Must be prefixed with 'aoc.' for Act-On Contacts fields or 'co.' for custom object fields. Use 'aoc.' or 'co.' to select all fields from respective source.

selectFields

page

int32

Page number (0-based)

size

int32

Number of items per page

sortBy

string

Sort by field. Reference Act-On Contacts fields by the prefix ao. if they overlap with custom object fields.

sortByDirection

string

Sort direction. Either asc or desc. If anything else no sorting will be applied.

filterExpression

string

Filter expression.

joinStrategy

object

Join strategy.

searchTerm

string

Search term.

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://custom-objects-service.aorpeks.act-on.net/v1/accountId/query/objectId/datasetId/joinWithOther \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

*/*

200Query executed successfully

400Bad request - invalid query parameters

401Unauthorized

403Forbidden

404Dataset or object not found

500Internal server error