List opportunities

Lists tenant opportunities using the OpportunityListFilters contract.

RBAC · opportunities

Query parameters

statusstringOptional

stagestringOptional

owner_idstring <uuid>Optional

client_idstring <uuid>Optional

opportunity_typestringOptional

stalled_onlystringOptional

searchstringOptional

pagestringOptional

page_sizestringOptional

sort_bystringOptional

sort_directionstringOptional

Response body

Success response 200 · schema OpportunityApiPaginatedV1

dataarray of objectRequired

itemsobject

paginationobject

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

metaobject

_linksobject

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

cURL

curl -X GET "https://algapsa.com/api/v1/opportunities?status=open&stage=identified&owner_id=01HN2K7VRB9PQ3Y0000000000&client_id=01HN2K7VRB9PQ3Y0000000000&opportunity_type=new_logo&stalled_only=true" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities?status=open&stage=identified&owner_id=01HN2K7VRB9PQ3Y0000000000&client_id=01HN2K7VRB9PQ3Y0000000000&opportunity_type=new_logo&stalled_only=true", {
  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?status=open&stage=identified&owner_id=01HN2K7VRB9PQ3Y0000000000&client_id=01HN2K7VRB9PQ3Y0000000000&opportunity_type=new_logo&stalled_only=true");
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": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  },
  "meta": {},
  "_links": {}
}