API Reference
HTTP API lets you access and work with a lot of Space modules and functionality (see the table of contents to the left for the entire list.)
The API uses a number of specific object types and enums described on this page.
Object types
ATimeZone type
object with fields :
|
ATimeZoneWithOffset type
object with fields :
|
AbsenceApproval type
object with fields :
|
AbsenceEvent type
object with fields :
|
AbsenceReasonRecord type
object with fields :
|
AbsenceRecord type
object with fields :
|
AccessRecord type
object with fields :
|
AllChannelsListEntry type
object with fields :
|
AllReactionsToItemRecord type
object with fields :
|
ApiIcon type
object with fields :
|
ApplicationPayload type
Name | Type |
---|---|
className | string Possible values: |
ArticleChannelRecord type
object with fields :
|
ArticleContentRecord type
object with fields :
|
ArticleDetailsRecord type
object with fields :
|
ArticleHitDetails type
object with fields :
|
ArticleImportResult type
object with fields :
|
ArticleMarkdownImage type
object with fields :
|
ArticlePreviewRecord type
object with fields :
|
ArticleRecord type
object with fields :
|
AssignedPerson type
object with fields :
|
Attachment type
Name | Type |
---|---|
className | string Possible values: |
AttachmentIn type
Name | Type |
---|---|
className | string Possible values: |
AttachmentInfo type
object with fields :
|
AuthModuleUsage type
object with fields :
|
AutomationJobExecutionUnfurlDetails type
object with fields :
|
AutomationJobUnfurlDetails type
object with fields :
|
AvatarCropSquare type
object with fields :
|
BG_ArticleAlias type
object with fields :
|
BG_ArticleId type
object with fields :
|
BG_Stats type
object with fields :
|
BaseMenuActionContext type
object with fields :
|
BillingFeedChannel type
object with fields :
|
BillingReport type
object with fields :
|
BirthdayEvent type
object with fields :
|
BlogCalendarEvent type
object with fields :
|
BlogPublicationDetails type
object with fields :
|
BoardColumn type
object with fields :
|
BoardColumns type
object with fields :
|
BoardInfo type
object with fields :
|
BoardMemberOwners type
object with fields :
|
BoardOwners type
object with fields :
|
BoardRecord type
object with fields :
|
BoardTeamOwners type
object with fields :
|
BoardWidgetData type
object with fields :
|
BookHitDetails type
object with fields :
|
BooleanCFType type
No properties |
BooleanCFValue type
object with fields :
|
Branch type
object with fields :
|
BranchInfo type
object with fields :
|
CAutomationTaskPrincipalDetails type
object with fields :
|
CBuiltInServicePrincipalDetails type
object with fields :
|
CExternalServicePrincipalDetails type
object with fields :
|
CFConstraint type
Name | Type |
---|---|
className | string Possible values: |
CFEnumValuesModification type
object with fields :
|
CFType type
Name | Type |
---|---|
className | string Possible values: |
CFValue type
Name | Type |
---|---|
className | string Possible values: |
CPrincipal type
object with fields :
|
CPrincipalDetails type
Name | Type |
---|---|
className | string Possible values: |
CUserPrincipalDetails type
object with fields :
|
CUserWithEmailPrincipalDetails type
object with fields :
|
CalendarEvent type
object with fields :
|
CalendarEventSpec type
object with fields :
|
CertainReactionToItemRecord type
object with fields :
|
CertificateInfo type
object with fields :
|
ChannelAttachmentMenuActionContext type
object with fields :
|
ChannelItemRecord type
object with fields :
|
ChannelItemSnapshot type
object with fields :
|
ChannelMessageMenuActionContext type
object with fields :
|
ChannelParticipant type
object with fields :
|
ChannelSpecificDefaults type
object with fields :
|
ChatChannel type
Name | Type |
---|---|
className | string Possible values: |
ChatChannel.FromId type
object with fields :
|
ChatChannel.FromName type
object with fields :
|
ChatMessage type
Name | Type |
---|---|
className | string Possible values: |
ChatMessage.Block type
object with fields :
|
ChatMessage.Text type
object with fields :
|
ChatModification type
Name | Type |
---|---|
className | string Possible values: |
Checklist type
object with fields :
|
ClientInfo type
object with fields :
|
CodeDiscussionAddedFeedEvent type
object with fields :
|
CodeDiscussionAnchor type
object with fields :
|
CodeDiscussionRecord type
object with fields :
|
CodeDiscussionSnippet type
Name | Type |
---|---|
className | string Possible values: |
CodeDiscussionSnippet.InlineDiffSnippet type
object with fields :
|
CodeDiscussionSnippet.PlainSnippet type
object with fields :
|
CodeLine type
object with fields :
|
CodeReviewDetailedInfo type
object with fields :
|
CodeReviewDiscussionAddedFeedEvent type
object with fields :
|
CodeReviewDiscussionCounter type
object with fields :
|
CodeReviewDiscussionRecord type
object with fields :
|
CodeReviewParticipant type
object with fields :
|
CodeReviewParticipantQualityGateSlot type
object with fields :
|
CodeReviewParticipantRecord type
object with fields :
|
CodeReviewParticipants type
object with fields :
|
CodeReviewPendingMessageCounter type
object with fields :
|
CodeReviewRecord type
Name | Type |
---|---|
className | string Possible values: |
CodeReviewWithCount type
object with fields :
|
CodeSnippetAnchor type
object with fields :
|
CommandDetail type
object with fields :
|
Commands type
object with fields :
|
CommitSetReviewRecord type
object with fields :
|
ContainerHelmChart type
object with fields :
|
ContainerHelmChartDependency type
object with fields :
|
ContainerImage type
object with fields :
|
ContainerImageAnnotation type
object with fields :
|
ContainerImageConfig type
object with fields :
|
ContainerImageLayer type
object with fields :
|
ContainerImagePlatform type
object with fields :
|
ContainerManifest type
object with fields :
|
ContainerPackageType type
object with fields :
|
ContainerPackageVersionDetails type
object with fields :
|
Counter type
object with fields :
|
Currency type
object with fields :
|
CustomField type
object with fields :
|
CustomFieldValue type
object with fields :
|
CustomFieldsRecord type
object with fields :
|
DR_Draft type
object with fields :
|
DR_DraftHeader type
object with fields :
|
DTO_FullRightWithoutType type
object with fields :
|
DTO_Meeting type
object with fields :
|
DTO_Right type
object with fields :
|
DTO_RightType type
object with fields :
|
DTO_RightType_Right type
object with fields :
|
DTO_RightsDeps type
object with fields :
|
DTO_RightsGroup type
object with fields :
|
DTO_RightsWithHierarchy type
object with fields :
|
DateCFConstraint type
object with fields :
|
DateCFType type
No properties |
DateCFValue type
object with fields :
|
DateTimeViewParams type
object with fields :
|
DeleteMessage type
object with fields :
|
DeletedAttachment type
object with fields :
|
Diff type
object with fields :
|
DiffContext type
DiffSide type
Name | Type |
---|---|
className | string Possible values: |
DiffSide.Empty type
object with fields :
|
DiffSide.NonEmpty type
object with fields :
|
DocumentFolderPublicationItem type
object with fields :
|
DocumentFolderRecord type
object with fields :
|
DocumentPublicationItem type
object with fields :
|
ES_App type
object with fields :
|
ES_ApplicationPassword type
object with fields :
|
ES_ApprovedScope type
object with fields :
|
ES_AuthModule type
object with fields :
|
ES_AuthModuleSettings type
ES_AuthenticationSession type
object with fields :
|
ES_AzureAuthModuleSettings type
object with fields :
|
ES_BuiltinAuthModuleSettings type
object with fields :
|
ES_BuiltinProfileLoginDetails type
object with fields :
|
ES_ContainerRegistrySettings type
object with fields :
|
ES_DefaultProfileLoginDetails type
object with fields :
|
ES_ExternalPasswordAuthModuleSettings type
Name | Type |
---|---|
className | string Possible values: |
ES_FederatedAuthModuleSettings type
Name | Type |
---|---|
className | string Possible values: |
ES_GithubAuthModuleSettings type
object with fields :
|
ES_GithubProfileLoginDetails type
object with fields :
|
ES_GoogleAuthModuleSettings type
object with fields :
|
ES_HiddenAuthModuleSettings type
object with fields :
|
ES_HubAuthModuleSettings type
object with fields :
|
ES_HubProfileLoginDetails type
object with fields :
|
ES_LdapAttributeNames type
object with fields :
|
ES_LdapAuthModuleSettings type
object with fields :
|
ES_MavenRepositorySettings type
object with fields :
|
ES_NpmRegistrySettings type
No properties |
ES_NuGetFeedSettings type
No properties |
ES_OAuth2AuthModuleSettings type
Name | Type |
---|---|
className | string Possible values: |
ES_OAuthConsent type
object with fields :
|
ES_OIDCAuthModuleSettings type
object with fields :
|
ES_PackageRepositorySettings type
Name | Type |
---|---|
className | string Possible values: |
ES_PasswordAuthModuleSettings type
Name | Type |
---|---|
className | string Possible values: |
ES_PermanentToken type
object with fields :
|
ES_ProfileLogin type
object with fields :
|
ES_ProfileLoginDetails type
Name | Type |
---|---|
className | string Possible values: |
ES_RefreshToken type
object with fields :
|
ES_SamlAttributeNames type
object with fields :
|
ES_SamlAuthModuleSettings type
object with fields :
|
ES_Service type
object with fields :
|
ES_SshKey type
object with fields :
|
ES_TeamMapping type
object with fields :
|
EditMessage type
object with fields :
|
EmojiReactionRecord type
object with fields :
|
EmojiSearchMatchData type
object with fields :
|
EntityHit type
object with fields :
|
EntityHitDetails type
Name | Type |
---|---|
className | string Possible values: |
EntityType type
object with fields :
|
EnumCFType type
object with fields :
|
EnumCFValue type
object with fields :
|
EnumListCFType type
object with fields :
|
EnumListCFValue type
object with fields :
|
EnumValueData type
object with fields :
|
EstimationDTO type
object with fields :
|
ExtendedType type
object with fields :
|
ExternalArticle type
object with fields :
|
ExternalCheckDTO type
object with fields :
|
ExternalEntityInfoRecord type
object with fields :
|
ExternalIssue type
object with fields :
|
FailureConditionDTO type
Name | Type |
---|---|
className | string Possible values: |
FeatureFlag type
object with fields :
|
FeedEvent type
Name | Type |
---|---|
className | string Possible values: |
FileAttachment type
object with fields :
|
Fingerprint type
object with fields :
|
FolderHitDetails type
object with fields :
|
FolderPublicationItem type
Name | Type |
---|---|
className | string Possible values: |
GitAuthorInfo type
object with fields :
|
GitCommitInfo type
object with fields :
|
GitCommitWithGraph type
object with fields :
|
GitCommitterProfile type
object with fields :
|
GitGraphLayoutEdge type
object with fields :
|
GitGraphLayoutLine type
object with fields :
|
GitGraphLayoutNode type
object with fields :
|
GlobalPermissionTarget type
No properties |
HA_DefaultValue type
Name | Type |
---|---|
className | string Possible values: |
HA_DefaultValue.Collection type
object with fields :
|
HA_DefaultValue.Const type
Name | Type |
---|---|
className | string Possible values: |
HA_DefaultValue.Const.EnumEntry type
object with fields :
|
HA_DefaultValue.Const.Primitive type
object with fields :
|
HA_DefaultValue.Map type
object with fields :
|
HA_DefaultValue.Reference type
object with fields :
|
HA_Deprecation type
object with fields :
|
HA_Dto type
object with fields :
|
HA_DtoField type
object with fields :
|
HA_Endpoint type
object with fields :
|
HA_Enum type
object with fields :
|
HA_Field type
object with fields :
|
HA_MenuId type
object with fields :
|
HA_Model type
object with fields :
|
HA_Parameter type
object with fields :
|
HA_Path type
object with fields :
|
HA_PathSegment type
Name | Type |
---|---|
className | string Possible values: |
HA_PathSegment.Const type
object with fields :
|
HA_PathSegment.PrefixedVar type
object with fields :
|
HA_PathSegment.Var type
object with fields :
|
HA_Resource type
object with fields :
|
HA_Right type
object with fields :
|
HA_Type type
Name | Type |
---|---|
className | string Possible values: |
HA_Type.Array type
object with fields :
|
HA_Type.Dto type
object with fields :
|
HA_Type.Enum type
object with fields :
|
HA_Type.Map type
object with fields :
|
HA_Type.Object type
object with fields :
|
HA_Type.Primitive type
object with fields :
|
HA_Type.Ref type
object with fields :
|
HA_Type.UrlParam type
object with fields :
|
HA_UrlParameter type
object with fields :
|
HA_UrlParameterOption type
Name | Type |
---|---|
className | string Possible values: |
HA_UrlParameterOption.Const type
object with fields :
|
HA_UrlParameterOption.Var type
object with fields :
|
HolidaysEvent type
object with fields :
|
ImageAttachment type
object with fields :
|
ImageAttachmentMeta type
object with fields :
|
ImageAttachmentVariant type
object with fields :
|
ImageAttachmentVariantsMeta type
object with fields :
|
ImportMetadata type
object with fields :
|
ImportSource type
object with fields :
|
ImportTransactionRecord type
object with fields :
|
ImportedEntityInfo type
object with fields :
|
InlineDiffLine type
object with fields :
|
IntCFConstraint type
object with fields :
|
IntCFType type
No properties |
IntCFValue type
object with fields :
|