Team Directory

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

array of MeetingRecord

id: string (Path) ( Required )

MeetingRecord

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

array of AbsenceEvent

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

array of BirthdayEvent

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

array of BirthdayEvent

startDate: string (format: full-date) (Query) ( Required )

endDate: string (format: full-date) (Query) ( Required )

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

workingDays: boolean (Query) ( Nullable and Optional , defaults to null)

array of HolidaysEvent

id: string (Path) ( Required )

object with fields:

• newStatus: EventParticipationStatus ( Required )

MeetingRecord

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

array of MembershipEvent

dateFrom: string (format: full-date) (Query) ( Required )

dateTo: string (format: full-date) (Query) ( Required )

member: string (Query) ( Nullable and Optional , defaults to null)

team: string (Query) ( Nullable and Optional , defaults to null)

location: string (Query) ( Nullable and Optional , defaults to null)

role: string (Query) ( Nullable and Optional , defaults to null)

array of NonWorkingDaysEvent

object with fields:

• name: string ( Required )

• expiresAt: string (format: date-time) ( Required )

• inviteeLimit: integer (format: int32) ( Required )

• team: string ( Nullable and Optional , defaults to null)

• role: string ( Nullable and Optional , defaults to null)

• project: ProjectIdentifier ( Nullable and Optional , defaults to null)

• projectRole: ProjectTeamRole ( Nullable and Optional )

• globalRole: GlobalRole ( Nullable and Optional )

object with fields:

• first: string ( Required )

• second: InvitationLink ( Required )

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

withDeleted: boolean (Query) ( Optional , defaults to false)

projects: array of ProjectIdentifier (Query) ( Nullable and Optional , defaults to null)

teams: array of string (Query) ( Nullable and Optional , defaults to null)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of InvitationLink ( Required )

invitationLinkId: string (Path) ( Required )

object with fields:

• name: string ( Nullable and Optional , defaults to null)

• expiresAt: string (format: date-time) ( Nullable and Optional , defaults to null)

• inviteeLimit: integer (format: int32) ( Nullable and Optional , defaults to null)

• team: string ( Nullable and Optional )

• position: string ( Nullable and Optional )

• project: ProjectIdentifier ( Nullable and Optional )

• projectRole: ProjectTeamRole ( Nullable and Optional , defaults to null)

No arguments

invitationLinkId: string (Path) ( Required )

No arguments

object with fields:

• inviteeEmail: string ( Required )

• inviteeFirstName: string ( Nullable and Optional , defaults to null)

• inviteeLastName: string ( Nullable and Optional , defaults to null)

• team: string ( Nullable and Optional , defaults to null)

• role: string ( Nullable and Optional , defaults to null)

• project: ProjectIdentifier ( Nullable and Optional , defaults to null)

• projectRole: ProjectTeamRole ( Nullable and Optional , defaults to null)

• globalRole: GlobalRole ( Nullable and Optional , defaults to null)

Invitation

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

withDeleted: boolean (Query) ( Optional , defaults to false)

projects: array of ProjectIdentifier (Query) ( Nullable and Optional , defaults to null)

teams: array of string (Query) ( Nullable and Optional , defaults to null)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of Invitation ( Required )

id: string (Path) ( Required )

object with fields:

• inviteeEmail: string ( Nullable and Optional , defaults to null)

• inviteeFirstName: string ( Nullable and Optional , defaults to null)

• inviteeLastName: string ( Nullable and Optional , defaults to null)

• team: string ( Nullable and Optional )

• role: string ( Nullable and Optional )

• project: ProjectIdentifier ( Nullable and Optional )

• projectRole: ProjectTeamRole ( Nullable and Optional , defaults to null)

No arguments

id: string (Path) ( Required )

No arguments

No arguments

array of TD_Language

withArchived: boolean (Query) ( Optional , defaults to false)

array of TD_LocationEquipmentType

name: string (Path) ( Required )

delete: boolean (Query) ( Required )

No arguments

object with fields:

• memberLocationId: string ( Required )

• x: integer (format: int32) ( Required )

• y: integer (format: int32) ( Required )

• mapId: string ( Required )

TD_LocationMapPoint

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

locationId: string (Query) ( Required )

includeUnmarked: boolean (Query) ( Optional , defaults to true)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_MemberInLocationMap ( Required )

locationPointId: string (Path) ( Required )

object with fields:

• x: integer (format: int32) ( Nullable and Optional , defaults to null)

• y: integer (format: int32) ( Nullable and Optional , defaults to null)

TD_LocationMapPoint

locationPointId: string (Path) ( Required )

delete: boolean (Query) ( Required )

No arguments

object with fields:

• name: string ( Required )

• timezone: string ( Nullable and Optional , defaults to null)

• workdays: array of integer (format: int32) ( Nullable and Optional , defaults to null)

• phones: array of string ( Nullable and Optional , defaults to null)

• emails: array of string ( Nullable and Optional , defaults to null)

• equipment: array of string ( Nullable and Optional , defaults to null)

• description: string ( Nullable and Optional , defaults to null)

• address: string ( Nullable and Optional , defaults to null)

• type: string ( Nullable and Optional , defaults to null)

• parentId: string ( Nullable and Optional , defaults to null)

• capacity: integer (format: int32) ( Nullable and Optional , defaults to null)

TD_Location

query: string (Query) ( Optional , defaults to "")

type: string (Query) ( Nullable and Optional , defaults to null)

withArchived: boolean (Query) ( Optional , defaults to false)

array of TD_Location

object with fields:

• ids: array of string ( Required )

array of TD_Location

id: string (Path) ( Required )

TD_Location

id: string (Path) ( Required )

TD_Location

id: string (Path) ( Required )

object with fields:

• name: string ( Nullable and Optional , defaults to null)

• timezone: string ( Nullable and Optional )

• customWorkdays: boolean ( Nullable and Optional , defaults to null)

• workdays: array of integer (format: int32) ( Nullable and Optional , defaults to null)

• phones: array of string ( Nullable and Optional , defaults to null)

• emails: array of string ( Nullable and Optional , defaults to null)

• equipment: array of string ( Nullable and Optional , defaults to null)

• description: string ( Nullable and Optional , defaults to null)

• address: string ( Nullable and Optional , defaults to null)

• type: string ( Nullable and Optional , defaults to null)

• parentId: string ( Nullable and Optional )

• mapId: string ( Nullable and Optional )

• capacity: integer (format: int32) ( Nullable and Optional )

TD_Location

id: string (Path) ( Required )

array of TD_Location

id: string (Path) ( Required )

TD_LocationMap

id: string (Path) ( Required )

object with fields:

• mapPictureId: string ( Required )

TD_LocationMap

No arguments

array of TD_LocationWithTimeZone

object with fields:

• member: ProfileIdentifier ( Required )

• location: string ( Required )

• since: string (format: full-date) ( Nullable and Optional , defaults to null)

• till: string (format: full-date) ( Nullable and Optional , defaults to null)

• previousLocation: string ( Nullable and Optional , defaults to null)

TD_MemberLocation

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

profiles: array of ProfileIdentifier (Query) ( Nullable and Optional , defaults to null)

locations: array of string (Query) ( Nullable and Optional , defaults to null)

since: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)

till: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)

withArchived: boolean (Query) ( Optional , defaults to false)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_MemberLocation ( Required )

memberLocationId: string (Path) ( Required )

TD_MemberLocation

memberLocationId: string (Path) ( Required )

object with fields:

• location: string ( Nullable and Optional , defaults to null)

• since: string (format: full-date) ( Nullable and Optional )

• till: string (format: full-date) ( Nullable and Optional )

TD_MemberLocation

memberLocationId: string (Path) ( Required )

delete: boolean (Query) ( Optional , defaults to true)

No arguments

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

teamId: string (Query) ( Nullable and Optional , defaults to null)

locationId: string (Query) ( Nullable and Optional , defaults to null)

roleId: string (Query) ( Nullable and Optional , defaults to null)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_MergedEvent ( Required )

object with fields:

• member: ProfileIdentifier ( Required )

• teamId: string ( Required )

• roleId: string ( Required )

• lead: boolean ( Optional , defaults to false)

  warning

  Deprecated since 2020-12-01: The property is deprecated. It will be removed in a future version.

• manager: ProfileIdentifier ( Nullable and Optional , defaults to null)

• activeSince: string (format: date-time) ( Nullable and Optional , defaults to null)

• activeTill: string (format: date-time) ( Nullable and Optional , defaults to null)

• previousMembershipId: string ( Nullable and Optional , defaults to null)

• requiresApproval: boolean ( Optional , defaults to false)

• customFieldValues: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)

TD_Membership

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

identifiers: array of TeamMembershipIdentifier (Query) ( Nullable and Optional , defaults to null)

profiles: array of ProfileIdentifier (Query) ( Nullable and Optional , defaults to null)

teams: array of string (Query) ( Nullable and Optional , defaults to null)

directTeams: boolean (Query) ( Optional , defaults to false)

roles: array of string (Query) ( Nullable and Optional , defaults to null)

directRoles: boolean (Query) ( Optional , defaults to false)

since: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

till: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

requiresApproval: boolean (Query) ( Nullable and Optional , defaults to null)

withArchived: boolean (Query) ( Optional , defaults to false)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_Membership ( Required )

batchInfo: string in one of the formats

• { etag: string , batchSize: integer (format: int32) }

(Query) ( Required )

object with fields:

• etag: string ( Required )

• data: array of TD_Membership ( Required )

• hasMore: boolean ( Required )

membershipId: string in one of the formats

• id: string

(Path) ( Required )

TD_Membership

membershipId: string (Path) ( Required )

object with fields:

• teamId: string ( Nullable and Optional , defaults to null)

• roleId: string ( Nullable and Optional , defaults to null)

• lead: boolean ( Nullable and Optional , defaults to null)

  warning

  Deprecated since 2020-12-01: The property is deprecated. It will be removed in a future version.

• manager: ProfileIdentifier ( Nullable and Optional )

• activeSince: string (format: date-time) ( Nullable and Optional )

• activeTill: string (format: date-time) ( Nullable and Optional )

• requiresApproval: boolean ( Optional , defaults to false)

• customFieldValues: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)

TD_Membership

membershipId: string (Path) ( Required )

delete: boolean (Query) ( Optional , defaults to true)

No arguments

membershipId: string (Path) ( Required )

till: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

No arguments

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

term: string (Query) ( Required )

teamId: string (Query) ( Nullable and Optional , defaults to null)

excludedMemberId: string (Query) ( Nullable and Optional , defaults to null)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_MemberProfile ( Required )

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

teamId: string (Query) ( Nullable and Optional , defaults to null)

direct: boolean (Query) ( Nullable and Optional , defaults to true)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of object with fields:

  • first: TD_MemberProfile ( Required )

  • second: TD_Membership ( Required )

  ( Required )

membershipRequestId: string (Path) ( Required )

object with fields:

• approved: boolean ( Required )

No arguments

membershipRequestId: string (Path) ( Required )

TD_Membership

membershipId: string (Path) ( Required )

object with fields:

• till: string (format: date-time) ( Required )

No arguments

object with fields:

• username: string ( Required )

• firstName: string ( Required )

• lastName: string ( Required )

• emails: array of string ( Optional , defaults to [])

• phones: array of string ( Optional , defaults to [])

• birthday: string (format: full-date) ( Nullable and Optional , defaults to null)

• about: string ( Nullable and Optional , defaults to null)

• messengers: array of string ( Optional , defaults to [])

• links: array of string ( Optional , defaults to [])

• notAMember: boolean ( Optional , defaults to false)

• joined: string (format: full-date) ( Nullable and Optional , defaults to null)

• left: string (format: full-date) ( Nullable and Optional , defaults to null)

• leftAt: string (format: date-time) ( Nullable and Optional , defaults to null)

• speaksEnglish: boolean ( Nullable and Optional , defaults to null)

• pictureAttachmentId: string ( Nullable and Optional , defaults to null)

• avatarCropSquare: AvatarCropSquare ( Nullable and Optional , defaults to null)

• customFieldValues: array of CustomFieldInputValue ( Optional , defaults to [])

• externalId: string ( Nullable and Optional , defaults to null)

• location: string ( Nullable and Optional , defaults to null)

• guest: boolean ( Nullable and Optional , defaults to null)

• guestType: GuestType ( Nullable and Optional , defaults to null)

• project: ProjectIdentifier ( Nullable and Optional , defaults to null)

• projectRole: ProjectTeamRole ( Nullable and Optional , defaults to null)

TD_MemberProfile

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

query: string (Query) ( Optional , defaults to "")

reportPastMembers: boolean (Query) ( Optional , defaults to false)

reportFutureMembers: boolean (Query) ( Nullable and Optional , defaults to false)

reportCurrentMembers: boolean (Query) ( Nullable and Optional , defaults to true)

teamId: string (Query) ( Nullable and Optional , defaults to null)

locationId: string (Query) ( Nullable and Optional , defaults to null)

roleId: string (Query) ( Nullable and Optional , defaults to null)

meOnTop: boolean (Query) ( Optional , defaults to false)

order: ProfileOrder (Query) ( Nullable and Optional , defaults to null)

orgRelation: ProfileOrgRelation (Query) ( Optional , defaults to "MEMBER")

profiles: array of ProfileIdentifier (Query) ( Nullable and Optional , defaults to null)

No more than 100 profiles can be returned in a single request.

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_MemberProfile ( Required )

email: string (Path) ( Required )

verified: boolean (Query) ( Optional , defaults to true)

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• username: string ( Nullable and Optional , defaults to null)

• firstName: string ( Nullable and Optional , defaults to null)

• lastName: string ( Nullable and Optional , defaults to null)

• emails: array of string ( Nullable and Optional , defaults to null)

• phones: array of string ( Nullable and Optional , defaults to null)

• birthday: string (format: full-date) ( Nullable and Optional )

• about: string ( Nullable and Optional , defaults to null)

• messengers: array of string ( Nullable and Optional , defaults to null)

• links: array of string ( Nullable and Optional , defaults to null)

• notAMember: boolean ( Nullable and Optional , defaults to null)

• joined: string (format: full-date) ( Nullable and Optional )

• left: string (format: full-date) ( Nullable and Optional )

• leftAt: string (format: date-time) ( Nullable and Optional )

• speaksEnglish: boolean ( Nullable and Optional , defaults to null)

• pictureAttachmentId: string ( Nullable and Optional )

• avatarCropSquare: AvatarCropSquare ( Nullable and Optional )

• customFieldValues: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)

• externalId: string ( Nullable and Optional )

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

teamIds: array of string (Query) ( Required )

boolean

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• dryrun: boolean ( Required )

• guestType: GuestType ( Nullable and Optional , defaults to null)

DryRunResult

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• dryrun: boolean ( Required )

DryRunResult

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• joined: string (format: full-date) ( Nullable and Optional )

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• at: string (format: date-time) ( Nullable and Optional , defaults to null)

TD_MemberProfile

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

at: string (format: date-time) (Query) ( Required )

TD_MemberProfile

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

array of ES_AuthenticationSession

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

sessionId: string (Path) ( Required )

No arguments

dashboard: string in one of the formats

• id: string

• profile: ProfileIdentifier

• { project: ProjectIdentifier , profile: ProfileIdentifier }

(Path) ( Required )

DashboardPreferencesRecord

dashboard: string in one of the formats

• id: string

• profile: ProfileIdentifier

• { project: ProjectIdentifier , profile: ProfileIdentifier }

(Path) ( Required )

object with fields:

• data: array of array of DashboardItemData ( Required )

No arguments

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

array of ES_OAuthConsent

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

application: string in one of the formats

• clientId: string

  Specifies application by the client id that it uses to authenticate in Space

  Read more

• id: string

  Specifies application by the identifier that can be fetched via Get all applications method

• me

  Specifies application that corresponds to the caller of this API method.

  Applicable only for calls made by Space applications.

(Path) ( Required )

No arguments

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

id: string (Path) ( Required )

No arguments

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

clientId: string (Path) ( Required )

No arguments

owner: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

id: string (Path) ( Required )

No arguments

widget: string in one of the formats

• id: string

• { profile: ProfileIdentifier , dashboard: DashboardIdentifier , widget: string }

(Path) ( Required )

WidgetSettingsRecord

widget: string in one of the formats

• id: string

• { profile: ProfileIdentifier , dashboard: DashboardIdentifier , widget: string }

(Path) ( Required )

object with fields:

• settings: WidgetSettingsDTO ( Required )

No arguments

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

profiles: array of ProfileIdentifier (Query) ( Optional , defaults to [])

since: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)

till: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of TD_ProfileWorkingDays ( Required )

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

array of Profile2FARequirement

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

TwoFactorAuthenticationStatus

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

TwoFactorAuthenticationSecret

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• enabled: boolean ( Required )

• code: integer (format: int32) ( Nullable and Optional , defaults to null)

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

code: integer (format: int32) (Query) ( Nullable and Optional , defaults to null)

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• code: integer (format: int32) ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• name: string ( Required )

• scope: string ( Required )

object with fields:

• first: ES_ApplicationPassword ( Required )

• second: string ( Required )

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

object with fields:

• next: string ( Required )

• totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

• data: array of ES_ApplicationPassword ( Required )

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

passwordId: string (Path) ( Required )

object with fields:

• name: string ( Nullable and Optional , defaults to null)

• scope: string ( Nullable and Optional , defaults to null)

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

passwordId: string (Path) ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• name: string ( Required )

Checklist

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

array of Checklist

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• name: string ( Required )

• tabIndentedLines: string ( Required )

Checklist

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

checklistId: string (Path) ( Required )

object with fields:

• targetParentId: string ( Required )

• afterItemId: string ( Nullable and Optional , defaults to null)

• tabIndentedLines: string ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

checklistId: string (Path) ( Required )

object with fields:

• name: string ( Optional )

• description: string ( Nullable and Optional )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

checklistId: string (Path) ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

array of Checklist

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

checklistId: string (Path) ( Required )

array of PlanItemChildren

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• name: string ( Required )

• folder: FolderIdentifier ( Required )

• bodyIn: DocumentBodyCreateIn ( Required )

• publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional , defaults to null)

Document

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

documentId: string (Path) ( Required )

Document

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

documentId: string (Path) ( Required )

object with fields:

• name: string ( Nullable and Optional , defaults to null)

• updateIn: DocumentBodyUpdateIn ( Nullable and Optional , defaults to null)

• publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional )

Document

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

documentId: string (Path) ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

object with fields:

• name: string ( Required )

• parentFolder: FolderIdentifier ( Required )

DocumentFolder

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

folder: string in one of the formats

• id: string

• root

• sharedWithMe

(Path) ( Required )

DocumentFolder

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

folder: string in one of the formats

• id: string

• root

• sharedWithMe

(Path) ( Required )

object with fields:

• name: string ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string

(Path) ( Required )

folder: string in one of the formats

• id: string

• root

• sharedWithMe

(Path) ( Required )

No arguments

profile: string in one of the formats

• externalId: string

• id: string

• me

• username: string