departments | Tradespace | Developer Documentation

query ExampleQuery($ancestorIds: [String!], $contactIds: [String!], $createdByUserIds: [String!], $createdOnMax: ISO8601Date, $createdOnMin: ISO8601Date, $levels: [Int!], $limit: Int, $page: Int, $parentIds: [String!], $q: String, $sortDirection: SortDirectionEnum, $sortField: String, $sourceEnums: [DepartmentSourceEnum!], $updatedByUserIds: [String!], $updatedOnMax: ISO8601Date, $updatedOnMin: ISO8601Date) {
  departments(ancestorIds: $ancestorIds, contactIds: $contactIds, createdByUserIds: $createdByUserIds, createdOnMax: $createdOnMax, createdOnMin: $createdOnMin, levels: $levels, limit: $limit, page: $page, parentIds: $parentIds, q: $q, sortDirection: $sortDirection, sortField: $sortField, sourceEnums: $sourceEnums, updatedByUserIds: $updatedByUserIds, updatedOnMax: $updatedOnMax, updatedOnMin: $updatedOnMin) {
    collection {
      ancestors
      children
      contactsCount
      createdAt
      createdByUser
      createdByUserId
      disclosuresCount
      externalId
      filingsCount
      id
    }
    metadata {
      count
      currentPage
      extra
      hasNextPage
      hasPreviousPage
      limitValue
      nextPage
      previousPage
      totalCount
      totalPages
    }
  }
}

{
  "ancestorIds": [
    "example"
  ],
  "contactIds": [
    "example"
  ],
  "createdByUserIds": [
    "example"
  ],
  "createdOnMax": "example",
  "createdOnMin": "example",
  "levels": [
    0
  ],
  "limit": 0,
  "page": 0,
  "parentIds": [
    "example"
  ],
  "q": "example",
  "sortDirection": "ASC",
  "sortField": "example",
  "sourceEnums": [
    "admin"
  ],
  "updatedByUserIds": [
    "example"
  ],
  "updatedOnMax": "example",
  "updatedOnMin": "example"
}

{
  "data": {
    "departments": {
      "collection": [
        {
          "ancestors": [
            null
          ],
          "children": [
            null
          ],
          "contactsCount": 0,
          "createdAt": "example",
          "createdByUser": {
            "avatarUrl": null,
            "contact": null,
            "createdAt": null,
            "email": null,
            "firstName": null,
            "fullName": null,
            "id": null,
            "lastName": null,
            "stateEnum": null,
            "updatedAt": null
          },
          "createdByUserId": "example",
          "disclosuresCount": 0,
          "externalId": "example",
          "filingsCount": 0,
          "id": "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 departments.

Arguments

ancestorIdslist of StringsOptional

The IDs of the departments whose descendants, at any depth, to return.

contactIdslist of StringsOptional

The IDs of the contacts in the departments 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.

levelslist of IntegersOptional

The tree levels of the records to return. Top-level departments are level 1.

limitIntegerOptional

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

pageIntegerOptional

The page number to return. Starts at 1.

parentIdslist of StringsOptional

The IDs of the departments whose direct children to return.

qStringOptional

The text to search for. Matches name.

sortDirectionSortDirectionEnumOptional

The sort direction. The default is DESC.

Allowed values:

sortFieldStringOptional

The field to sort by. One of created_at, updated_at, name, contacts_count, disclosures_count, filings_count, and ideas_count. The default is created_at.

sourceEnumslist of DepartmentSourceEnumsOptional

The source values of the records to return.

Allowed values:

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

a DepartmentCollection

collectionlist of Departments

A collection of paginated DepartmentCollection

metadataCollectionMetadata

Pagination Metadata for navigating the Pagination