Get a deal | Tradespace | Developer Documentation

query ExampleQuery($id: String!) {
  deal(id: $id) {
    agreementsCount
    archivedAt
    archivedByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    commentsCount
    createdAt
    createdByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    createdByUserId
    dealContacts {
      contact
      createdAt
      id
      updatedAt
    }
    dealMatters {
      createdAt
      id
      matter
      matterId
      matterType
      updatedAt
    }
    description
  }
}

{
  "data": {
    "deal": {
      "agreementsCount": 0,
      "archivedAt": "example",
      "archivedByUser": {
        "avatarUrl": "example",
        "contact": {
          "addressStateCode": null,
          "archivedAt": null,
          "archivedByUser": null,
          "contactAddresses": null,
          "contactCitizenships": null,
          "contactClassifications": null,
          "contactDetails": null,
          "contactOrganizations": null,
          "contactRoles": null,
          "country": null
        },
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "fullName": "example",
        "id": "example",
        "lastName": "example",
        "stateEnum": "disabled",
        "updatedAt": "example"
      },
      "commentsCount": 0,
      "createdAt": "example",
      "createdByUser": {
        "avatarUrl": "example",
        "contact": {
          "addressStateCode": null,
          "archivedAt": null,
          "archivedByUser": null,
          "contactAddresses": null,
          "contactCitizenships": null,
          "contactClassifications": null,
          "contactDetails": null,
          "contactOrganizations": null,
          "contactRoles": null,
          "country": null
        },
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "fullName": "example",
        "id": "example",
        "lastName": "example",
        "stateEnum": "disabled",
        "updatedAt": "example"
      },
      "createdByUserId": "example",
      "dealContacts": [
        {
          "contact": {
            "addressStateCode": null,
            "archivedAt": null,
            "archivedByUser": null,
            "contactAddresses": null,
            "contactCitizenships": null,
            "contactClassifications": null,
            "contactDetails": null,
            "contactOrganizations": null,
            "contactRoles": null,
            "country": null
          },
          "createdAt": "example",
          "id": "example",
          "updatedAt": "example"
        }
      ],
      "dealMatters": [
        {
          "createdAt": "example",
          "id": "example",
          "matter": {
            "accountLeadInstitution": null,
            "accountPastPatentExpenses": null,
            "accountShareOfNetConsideration": null,
            "accountShareOfPatentCost": null,
            "adminFeeAmount": null,
            "adminFeeCap": null,
            "adminFeePercentage": null,
            "agreementAccountClassifications": null,
            "agreementClassifications": null,
            "agreementContacts": null
          },
          "matterId": "example",
          "matterType": "example",
          "updatedAt": "example"
        }
      ],
      "description": "example"
    }
  }
}

Returns a deal by ID.

Arguments

idStringRequired

The ID of the deal to return.

Returns

a Deal

createdAtString

The deal's creation date.

dealContactslist of DealContacts

The contacts involved in the deal.

dealMatterslist of DealMatters

The links between the deal and the disclosures, patents, and other matters attached to it.

idString

The deal's unique identifier.

updatedAtString

The date the deal was last updated.

agreementsCountIntegerOptional

The number of agreements linked to the deal.

archivedAtStringOptional

The date the deal was archived. Returns null if the deal is active.

archivedByUserUserOptional

The user who archived the deal.

commentsCountIntegerOptional

The number of comments on the deal.

createdByUserUserOptional

The user who created the deal.

createdByUserIdStringOptional

The unique identifier of the user who created the deal.

descriptionStringOptional

The deal's description.

disclosuresCountIntegerOptional

The number of disclosures linked to the deal.

externalIdStringOptional

The deal's identifier in an external system. Set when the deal is imported.

lastActivityAtStringOptional

The date of the most recent activity on the deal.

matterDocumentsCountIntegerOptional

The number of documents attached to the deal.

opportunitiesCountIntegerOptional

The number of opportunities linked to the deal.

ownerUserUserOptional

The user who owns the deal.

sourceEnumDealSourceEnumOptional

How the deal was created, such as manually or by import.

Allowed values:

stageLookupLookupUnionOptional

The deal’s pipeline stage. A global or account-specific lookup value.

titleStringOptional

The deal's title.

typeEnumDealTypeEnumOptional

The deal's type.

Allowed values:

updatedByUserUserOptional

The user who last updated the deal.

updatedByUserIdStringOptional

The unique identifier of the user who last updated the deal.