Skip to main content

ProjectCustomerListResponse

data object[]required
  • Array [
    • idstring<uuid>required
    Example: a81c2e15-1e47-4e0d-9fba-7a214faad56f
    publicIdstringrequired
    Example: PRJ-1234
    description objectrequired

    Project description in markdown format.

    oneOf
    string
    latestRound object

    Latest round details. Included only when requested via the fields query parameter.

    namestringrequired
    Example: Round 1
    statusstringrequired

    Round lifecycle for the latest round: "draft" (not published), "published" (open for bidding), "completed" (bidding deadline has passed).

    Possible values: [draft, published, completed]

    Example: draft
    statusstringrequired

    Project lifecycle status: "draft" on creation, "published" after the first round is published, and "finished" after awarding.

    Possible values: [published, draft, finished]

    Example: published
    projectTypestringrequired

    "rfx" = no bid sheet and no questionnaire, "rfq" = bid sheet but no questionnaire, "rfi" = questionnaire but no bid sheet, "rfp" = bid sheet and questionnaire, "auction" = auction project.

    Possible values: [rfq, rfx, rfp, rfi, auction]

    Example: rfq
    mainContact object

    User details of the main project contact.

    emailstring<email>required
    Example: contact@archlet.ch
    currencyCodestringrequired
    Example: USD
    attributes object

    Attributes of the project. The keys are the attribute names, and the values are the attribute values. By default no attributes are set.

    property name* object
    oneOf
    string

    Value for a "List - Single selection", "Text", "Date", or "User - Invited team member" attribute

    userAccesses object[]

    List of users who have access to the project

  • Array [
    • userIdstring<uuid>required
    Example: 77640af3-20be-48dd-8751-6b8f8c1c2d77
    emailstring<email>required
    Example: contact@archlet.ch
    effectiveRolestringrequired

    Possible values: [editor, viewer]

    Example: editor
    accessSourcestringrequired

    The source of the user access. If the user is an admin or cross project viewer, the access source is admin/crossProjectViewer respectively. If the user is invited to a project, the access source is projectInvite. If a user is invited to a project and has a tenant-wide role, two different access sources will be returned.

    Possible values: [projectInvite, admin, viewer]

    Example: projectInvite
    firstNamestringrequired
    Example: Alicia
    lastNamestringrequired
    Example: Rice
  • ]
    • namestringrequired
    nameForSuppliersstringrequired
    organizationNameForSuppliers objectrequired
    oneOf
    string
    createdAtstring<date-time>required
    isTestbooleanrequired
  • ]
    • pagination objectrequired
    nextCursor objectrequired

    A cursor used to fetch the next page of results. It is null if there is no next page. Use the value as cursor parameter to fetch the next page.

    oneOf
    string
    hasMorebooleanrequired

    Indicates whether there are more results available. Keep calling the API with the provided nextCursor until hasMore is false to retrieve all results.

    totalnumberrequired

    The total number of results available.

    Example: 42
    ProjectCustomerListResponse
    {
      "data": [
        {
          "id": "a81c2e15-1e47-4e0d-9fba-7a214faad56f",
          "publicId": "PRJ-1234",
          "description": null,
          "latestRound": {
            "name": "Round 1",
            "status": "draft"
          },
          "status": "published",
          "projectType": "rfq",
          "mainContact": {
            "email": "contact@archlet.ch"
          },
          "currencyCode": "USD",
          "attributes": {
            "category": [
              [
                "Packaging",
                "Bottles",
                "PET and plastic"
              ],
              [
                "Packaging",
                "Bottles",
                "Glass"
              ]
            ],
            "isInformationalProject": false,
            "estimatedTotalSavings": 250000,
            "estimatedContractDurationYears": 3,
            "estimatedBaselineSpend": {
              "quantity": 1200000,
              "currency": "USD"
            },
            "realisedTotalSpend": {
              "quantity": 950000,
              "currency": "USD"
            },
            "realisedTotalSavings": {
              "quantity": 180000,
              "currency": "USD"
            },
            "projectStartDate": "2026-01-01",
            "projectEndDate": "2026-06-30",
            "contractStartDate": "2026-07-01"
          },
          "userAccesses": [
            {
              "userId": "e7380053-ab20-4bd9-bdc9-eaffa2804cf9",
              "email": "contact@archlet.ch",
              "effectiveRole": "editor",
              "accessSource": "projectInvite",
              "firstName": "Katelin",
              "lastName": "Tromp"
            }
          ],
          "name": "string",
          "nameForSuppliers": "string",
          "organizationNameForSuppliers": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "isTest": true
        }
      ],
      "pagination": {
        "nextCursor": "MjAyNS0wMS0wMSAxNzoyOTo1OS4yNwo=",
        "hasMore": true,
        "total": 42
      }
    }