Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

List projects

List filters are passed as query parameters — see the conventions in the introduction.

GET/project
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses
200

OK.

Array of Project
idstring

Project ID (read-only, autoassigned)

appIdstring

App ID (read-only, autoassigned)

statestring

Always "confirmed" for projects (read-only, autoassigned)

ticketSidstring

Ticket SID (read-only, autoassigned)

projectSidstring

Project SID (read-only, autoassigned)

customIdstring

Custom ID

statusNamestring

Status name

prioritystring

Priority

orderCreatedAtstring

Order creation date (ISO date, read-only, autoassigned)

upatedAtstring

Update date (ISO date, read-only, autoassigned)

lastActivitystring

Last activity date (ISO date, read-only, autoassigned)

quoteIdstring

Quote ID (read-only, autoassigned)

poNumberstring

PO number (create-only)

customerIdstring

Customer ID (read-only, autoassigned)

paymentMethodNamestring

Payment method name (read-only)

totalNetPricenumber

Total net price (read-only)

totalGrossPricenumber

Total gross price (read-only)

deliveryMethodTypestring

Delivery method type: SIMPLE, ADVANCED, COLLECTION_CENTER (create-only)

deliveryMethodNamestring

Delivery method name (create-only)

netDeliveryPricenumber

Net delivery price (read-only)

grossDeliveryPricenumber

Gross delivery price (read-only)

deliveryVatPercentnumber

Delivery VAT percent (read-only)

profitCenterNamestring

Profit center name (read-only)

alternativeContactIdstring

Alternative contact ID (read-only, autoassigned)

alternativeContactEmailstring

Alternative contact email (read-only)

quotationFormRegionIdstring

Quotation form region ID

costCenterobject

Cost center (read-only)

billingAddressobject

Billing address: firstName, lastName, companyName, companyNumber, address, addressSecondLine, city, postCode, telephone, fax, email, industryName, countryName, countryCode (2-digit), countryISO (3-digit), stateName, stateISO, vatId, department

shippingAddressobject

Shipping address: firstName, lastName, companyName, address, addressSecondLine, city, postCode, telephone, fax, email, countryName, countryCode (2-digit), countryISO (3-digit), stateName, stateISO, department, deliveryInstructions

namestring

Project name; not returned in list/retrieve (create-only)

ticketIdstring

Temporary, creates ticket with specific ticketSid; not returned in list/retrieve (create-only)

projectIdstring

Temporary, creates ticket with specific projectSid; not returned in list/retrieve (create-only)

additionalFilesobject

Map of fileName to {url, headers}

401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/project' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "id": "1075",
    "additionalFiles": {
      "file.pdf": "http://example-download.url"
    },
    "customProperties": {
      "comment": "high quality"
    },
    "state": "confirmed",
    "appId": "1677",
    "ticketSid": "X-88-TICKET-95080",
    "projectSid": "X-88-ORDER-95000",
    "customId": "PROJECT-0001",
    "statusName": "New",
    "priority": "LOW",
    "orderCreatedAt": "2021-09-23T08:41:23.118Z",
    "contactEmail": "example@amfg.ai"
  }
]