Make your first request

This request lists the research goals for one project. It proves that your API key, base URL, project ID, and generated client are configured correctly.

Before you start

Prepare the client and credentials

• Install @orvelt/business.
• Set ORVELT_BUSINESS_API_KEY to an organization API key.
• Set ORVELT_PROJECT_ID to any project in that organization.
• Call orvelt once during application startup.

Send the goals request

List the first 20 research goals for a project.

import { goals } from '@orvelt/business';

const result = await goals.list({
  projectId: process.env.ORVELT_PROJECT_ID!,
  page: 1,
  limit: 20,
});

if (result.error) {
  throw new Error(result.error.message);
}

console.log(result.data);

curl --request GET \\
  --url "$ORVELT_API_BASE_URL/project/$ORVELT_PROJECT_ID/goals?page=1&limit=20" \\
  --header "x-api-key: $ORVELT_BUSINESS_API_KEY"

The SDK returns { data, error, request, response } by default. A successful response contains the goals collection and pagination information defined by the current contract.

Verify the result

Check status and permissions

Run the request from a server process. A successful response has a 2xx status. If you receive 401, check the key value and header configuration. If you receive 403, the key may not have the project.goals read permission.

Next steps

• Read response handling.
• Learn about permissions.
• Follow the feedback program guide.