List opportunities | Tradespace | Developer Documentation

query ExampleQuery($archived: ArchivedEnum, $contactIds: [String!], $createdByUserIds: [String!], $createdOnMax: ISO8601Date, $createdOnMin: ISO8601Date, $disclosureIds: [String!], $displayEnums: [OpportunityDisplayEnum!], $limit: Int, $opportunityNumber: String, $organizationIds: [String!], $page: Int, $q: String, $shareEnums: [OpportunityShareEnum!], $sortDirection: SortDirectionEnum, $sortField: String, $stateEnums: [OpportunityStateEnum!], $trlEnums: [TrlEnum!], $updatedByUserIds: [String!], $updatedOnMax: ISO8601Date, $updatedOnMin: ISO8601Date) {
  opportunities(archived: $archived, contactIds: $contactIds, createdByUserIds: $createdByUserIds, createdOnMax: $createdOnMax, createdOnMin: $createdOnMin, disclosureIds: $disclosureIds, displayEnums: $displayEnums, limit: $limit, opportunityNumber: $opportunityNumber, organizationIds: $organizationIds, page: $page, q: $q, shareEnums: $shareEnums, sortDirection: $sortDirection, sortField: $sortField, stateEnums: $stateEnums, trlEnums: $trlEnums, updatedByUserIds: $updatedByUserIds, updatedOnMax: $updatedOnMax, updatedOnMin: $updatedOnMin) {
    collection {
      additionalInformation
      archivedAt
      archivedByUser
      availabilities
      availableData
      background
      benefits
      commercialApplications
      coverImageAltText
      coverImageUrl
    }
    metadata {
      count
      currentPage
      extra
      hasNextPage
      hasPreviousPage
      limitValue
      nextPage
      previousPage
      totalCount
      totalPages
    }
  }
}

{
  "archived": "EXCLUDE",
  "contactIds": [
    "example"
  ],
  "createdByUserIds": [
    "example"
  ],
  "createdOnMax": "example",
  "createdOnMin": "example",
  "disclosureIds": [
    "example"
  ],
  "displayEnums": [
    "featured"
  ],
  "limit": 0,
  "opportunityNumber": "example",
  "organizationIds": [
    "example"
  ],
  "page": 0,
  "q": "example",
  "shareEnums": [
    "marketplace"
  ],
  "sortDirection": "ASC",
  "sortField": "example",
  "stateEnums": [
    "in_progress"
  ],
  "trlEnums": [
    "level_1"
  ],
  "updatedByUserIds": [
    "example"
  ],
  "updatedOnMax": "example",
  "updatedOnMin": "example"
}

{
  "data": {
    "opportunities": {
      "collection": [
        {
          "additionalInformation": "example",
          "archivedAt": "example",
          "archivedByUser": {
            "avatarUrl": null,
            "contact": null,
            "createdAt": null,
            "email": null,
            "firstName": null,
            "fullName": null,
            "id": null,
            "lastName": null,
            "stateEnum": null,
            "updatedAt": null
          },
          "availabilities": {},
          "availableData": "example",
          "background": "example",
          "benefits": "example",
          "commercialApplications": "example",
          "coverImageAltText": "example",
          "coverImageUrl": "example"
        }
      ],
      "metadata": {
        "count": 0,
        "currentPage": 0,
        "extra": {},
        "hasNextPage": true,
        "hasPreviousPage": true,
        "limitValue": 0,
        "nextPage": 0,
        "previousPage": 0,
        "totalCount": 0,
        "totalPages": 0
      }
    }
  }
}

Returns a paginated collection of opportunities.

Arguments

archivedArchivedEnumOptional

The archived state of the records to return. The default is EXCLUDE.

Allowed values:

contactIdslist of StringsOptional

The IDs of the contacts linked to the records to return.

createdByUserIdslist of StringsOptional

The IDs of the users who created the records to return.

createdOnMaxStringOptional

The latest creation date to return.

createdOnMinStringOptional

The earliest creation date to return.

disclosureIdslist of StringsOptional

The IDs of the disclosures linked to the records to return.

displayEnumslist of OpportunityDisplayEnumsOptional

The display settings of the opportunities to return.

Allowed values:

limitIntegerOptional

The number of records returned. The default is 20, and the maximum is 500.

opportunityNumberStringOptional

The opportunity number to return. Matching is case-insensitive.

organizationIdslist of StringsOptional

The IDs of the organizations linked to the records to return.

pageIntegerOptional

The page number to return. Starts at 1.

qStringOptional

The text to search for. Matches opportunity number, title, and page title.

shareEnumslist of OpportunityShareEnumsOptional

The sharing settings of the opportunities to return.

Allowed values:

sortDirectionSortDirectionEnumOptional

The sort direction. The default is DESC.

Allowed values:

sortFieldStringOptional

The field to sort by. One of archived_at, created_at, disclosures_count, display_enum, expires_on, opportunity_number, page_title, share_enum, state_enum, title, trl_enum, and updated_at. The default is created_at.

stateEnumslist of OpportunityStateEnumsOptional

The states of the records to return.

Allowed values:

trlEnumslist of TrlEnumsOptional

The technology readiness levels of the records to return.

updatedByUserIdslist of StringsOptional

The IDs of the users who last updated the records to return.

updatedOnMaxStringOptional

The latest last-updated date to return.

updatedOnMinStringOptional

The earliest last-updated date to return.

Returns

an OpportunityCollection

collectionlist of Opportunities

A collection of paginated OpportunityCollection

metadataCollectionMetadata

Pagination Metadata for navigating the Pagination