department | Tradespace | Developer Documentation

query ExampleQuery($id: String!) {
  department(id: $id) {
    ancestors
    children
    contactsCount
    createdAt
    createdByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    createdByUserId
    disclosuresCount
    externalId
    filingsCount
    id
  }
}

{
  "data": {
    "department": {
      "ancestors": [
        null
      ],
      "children": [
        null
      ],
      "contactsCount": 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",
      "disclosuresCount": 0,
      "externalId": "example",
      "filingsCount": 0,
      "id": "example"
    }
  }
}

Returns a department by ID.

Arguments

idStringRequired

The ID of the department to return.

Returns

a Department

ancestorslist of Departments

The department's ancestors, from the root down.

childrenlist of Departments

The department's direct children.

createdAtString

The department's creation date.

idString

The department's unique identifier.

updatedAtString

The date the department was last updated.

contactsCountIntegerOptional

The number of contacts in the department.

createdByUserUserOptional

The user who created the department.

createdByUserIdStringOptional

The unique identifier of the user who created the department.

disclosuresCountIntegerOptional

The number of disclosures linked to the department.

externalIdStringOptional

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

filingsCountIntegerOptional

The number of filings linked to the department.

ideasCountIntegerOptional

The number of ideas linked to the department.

logoUrlStringOptional

The URL of the department's logo.

matterDocumentsCountIntegerOptional

The number of documents attached to the department.

nameStringOptional

The department's name.

sourceEnumDepartmentSourceEnumOptional

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

Allowed values:

updatedByUserUserOptional

The user who last updated the department.

updatedByUserIdStringOptional

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