POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  apiKey: "<YOUR_API_KEY_HERE>",
  workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});

async function run() {
  const result = await intunedClient.project.run.sync("my-project", {
    api: "get-contracts",
    parameters: {
      "page": 1,
      "isLastPage": false,
    },
    retry: {
      maximumAttempts: 3,
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
  "status": "completed",
  "runId": "aabbccddeeffggh",
  "statusCode": 200,
  "result": {
    "contracts": [
      {
        "id": "#1",
        "contractor": {
          "name": "John Doe",
          "phone": 1234567890
        }
      },
      {
        "id": "#2",
        "contractor": {
          "name": "Jane Doe",
          "phone": 987654321
        }
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string
required

Your workspace ID. How to find it?

​
projectName
string
required

Your project name. It is the name you provide when creating a project.

Body

application/json
run project api request

Run API request

​
api
any
required
​
parameters
any
required
​
retry
object

Retry policy configurations

​
authSession
object

Auth session configurations

​
proxy
string

Proxy URL following this format: http://username:password@domain:port

Example:

"http://username:password@domain:port"

Response

200
application/json
Successful run result

Completed API run result

​
status
enum<string>
required

The status of the run

Available options:
completed
​
statusCode
number
required

The HTTP status code of the API run

​
runId
string
required

The run ID

​
result
any

The result of an API call.