Opportunity

The opportunity resource.

Basehttps://rest.carbon.ms/opportunity

GET/opportunity

List opportunitys

Retrieve a paginated list of opportunitys. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/opportunity

curl --request GET \
  --url 'https://rest.carbon.ms/opportunity?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "purchaseOrderDocumentPath": "string",
    "requestForQuoteDocumentPath": "string",
    "customerId": "xyz789"
  }
]

GET/opportunity

Retrieve a opportunity

Fetch a single opportunity by filtering on `id`.

Query parameters

idstring

Match on the opportunity's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/opportunity

curl --request GET \
  --url 'https://rest.carbon.ms/opportunity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseOrderDocumentPath": "string",
  "requestForQuoteDocumentPath": "string",
  "customerId": "xyz789"
}

POST/opportunity

Create a opportunity

Create a new opportunity.

Body parameters

companyIdstringrequired

References company.id

purchaseOrderDocumentPathstring

requestForQuoteDocumentPathstring

customerIdstring

References customer.id

POSThttps://rest.carbon.ms/opportunity

curl --request POST \
  --url https://rest.carbon.ms/opportunity \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseOrderDocumentPath": "string",
  "requestForQuoteDocumentPath": "string",
  "customerId": "xyz789"
}

PATCH/opportunity

Update a opportunity

Update an existing opportunity, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

purchaseOrderDocumentPathstring

requestForQuoteDocumentPathstring

customerIdstring

References customer.id

PATCHhttps://rest.carbon.ms/opportunity

curl --request PATCH \
  --url 'https://rest.carbon.ms/opportunity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseOrderDocumentPath": "string",
  "requestForQuoteDocumentPath": "string",
  "customerId": "xyz789"
}

DELETE/opportunity

Delete a opportunity

Delete a opportunity, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the opportunity to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/opportunity

curl --request DELETE \
  --url 'https://rest.carbon.ms/opportunity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content