Skip to main content
POST
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
objects
/
{objectName}
Trigger a read
curl --request POST \
  --url https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "groupRef": "<string>",
  "mode": "async",
  "sinceTimestamp": "2024-07-01T18:22:30.323771761Z",
  "untilTimestamp": "2024-07-05T18:22:30.323771761Z"
}
'
{
  "operationId": "60deaf48-3856-4a2b-bfd4-3de85125eca8"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required
​
integrationId
string
required
​
objectName
string
required

Body

application/json

Read Request

​
groupRef
string
required

The ID of the user group whose SaaS instance you'd like to read data from. This is the ID that was provided during installation creation.

​
mode
enum<string>
required

The mode of read operation. Currently only asynchronus operation is supported.

Available options:
async
Example:

"async"

​
sinceTimestamp
string

The UTC timestamp from which to read data. If omitted, we will read all data.

Example:

"2024-07-01T18:22:30.323771761Z"

​
untilTimestamp
string

The UTC timestamp until which to read data.

Example:

"2024-07-05T18:22:30.323771761Z"

Response

The success response

​
operationId
string
required

The operation ID

Example:

"60deaf48-3856-4a2b-bfd4-3de85125eca8"