GET
/
projects
/
{projectIdOrName}
/
operations
/
{operationId}
Get an operation
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId} \
  --header 'X-Api-Key: <api-key>'
{
  "projectId": "project-456",
  "integrationId": "<string>",
  "configId": "config-123",
  "actionType": "read",
  "id": "<string>",
  "installationId": "<string>",
  "status": "success",
  "result": "[object] No changes",
  "metadata": {},
  "createTime": "2023-07-13T21:34:44.816Z"
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required

The Ampersand project ID or project name.

operationId
string
required

Operation ID.

Response

Operation

projectId
string
required

The Ampersand project ID.

Example:

"project-456"

integrationId
string
required

The integration ID.

configId
string
required

The config ID.

Example:

"config-123"

actionType
string
required

The action type to perform for the given object.

Example:

"read"

id
string
required

The operation ID.

installationId
string
required

The Ampersand installation ID.

status
string
required

The status of the operation.

Example:

"success"

result
string

The result of the operation.

Example:

"[object] No changes"

metadata
object

Metadata associated with the operation.

Example:
{}
createTime
string<date-time>

The time the operation was created.

Example:

"2023-07-13T21:34:44.816Z"