List opportunity steps

Lists the current opportunity plan, including done, current, and planned steps.

RBAC · opportunities

Path parameters

idstring <uuid>Required

Opportunity UUID from opportunities.opportunity_id.

Response body

Success response 200 · schema OpportunityApiArraySuccessV1

dataarray of objectRequired

itemsobject

metaobject

Response codes

200

Operation succeeded.

400

Validation or request parsing failure.

401

API key missing or invalid.

403

RBAC denied for the opportunities resource action.

404

Opportunity or nested resource not found.

409

Opportunity state conflicts with the requested operation.

500

Unexpected controller or service failure.

GET /api/v1/opportunities/{id}/steps

cURL

curl -X GET "https://algapsa.com/api/v1/opportunities/{id}/steps" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}/steps", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/opportunities/{id}/steps");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "meta": {}
}