رموز API
أنشئ رمزًا من الإعدادات ← رموز API، وأرسله بهذا الشكل: Authorization: Bearer tmanage_pat_… الرمز يعمل على مساحة عمل واحدة، ويمكنك إلغاؤه في أي وقت.
جديد · 4 دقائق
تابع طلبًا واحدًا من البداية حتى الاعتماد
جولة قصيرة من أول طلب حتى النسخة المعتمدة.
شاهد رحلة العملالقوالب
قوالب لتسليم أعمال العملاء
ابدأ بمسار جاهز من الطلب حتى الاعتماد، يناسب نوع فريقك.
تصفّح القوالبدليل عملي
دليل اعتمادات العملاء
كيف تحصل فرق الخدمات على قرار واضح وموثّق من العميل من أول مرة.
اقرأ الدليلاربط أدواتك برمز وصول أو OAuth، والتزم بحدود الطلبات، واستقبل Webhooks موقّعة، واطّلع على كل نقاط النهاية.
كل طلب يُنفَّذ باسم عضو واحد في مساحة عمل واحدة، ويتحقق API من صلاحيات هذا العضو مع كل طلب.
أنشئ رمزًا من الإعدادات ← رموز API، وأرسله بهذا الشكل: Authorization: Bearer tmanage_pat_… الرمز يعمل على مساحة عمل واحدة، ويمكنك إلغاؤه في أي وقت.
التطبيقات ومساعدات الذكاء الاصطناعي تتصل عبر OAuth 2.1 مع PKCE، والعضو يوافق على الصلاحيات: قراءة أو كتابة أو إدارة. صلاحية الفوترة لا تُضاف تلقائيًا أبدًا.
عند تجاوز الحد، يرد API بالرمز 429 Too Many Requests ومعه header اسمه Retry-After. انتظر عدد الثواني المذكور فيه، ثم أعد المحاولة.
كل إرسال يكون موقّعًا. تحقّق من X-TManage-Signature (HMAC-SHA256 للطابع الزمني ومحتوى الطلب)، وارفض أي طابع زمني يختلف بأكثر من 5 دقائق.
X-TManage-Timestamp: 1767225600 X-TManage-Signature: v1=<hex HMAC-SHA256(secret, "<timestamp>.<body>")> X-TManage-Event: work_item.created
كل نقاط النهاية في API، مقسّمة حسب المجال.
/organizationscreateOrganizationIdempotency-Key · header · string · مطلوبCreateOrganizationRequest201 · Organization Organization and owner membership created transactionally.400 · Error Invalid request or transition.409 · Error Version, state, or idempotency fingerprint conflict.CreateOrganizationRequestname: string · مطلوبtimezone: string · مطلوبdefaultLocale: en | ar · مطلوبOrganizationid: Id · مطلوبname: string · مطلوبslug: string · مطلوبtimezone: string · مطلوبdefaultLocale: string · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/projectscreateProjectorganizationId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateProjectRequest201 · Project Project created403 · Error Principal lacks capability; response does not reveal hidden object details.CreateProjectRequestworkspaceId: Id · مطلوبname: string · مطلوبownerUserId: Id · مطلوبtargetAt: one oftemplate: agency_delivery | software_studio | consulting_engagementProjectid: Id · مطلوبorganizationId: Id · مطلوبworkspaceId: Id · مطلوبname: string · مطلوبownerUserId: Id · مطلوبcommittedAt: one offorecastAt: one ofErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/projects/{projectId}/client-organizationslinkClientOrganizationorganizationId · path · string (uuid) · مطلوبprojectId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبLinkClientOrganizationRequest201 · ClientOrganization Client organization linked with explicit policy403 · Error Principal lacks capability; response does not reveal hidden object details.LinkClientOrganizationRequestname: string · مطلوبapprovalPolicy: all_required | any_one | ordered · مطلوبdefaultInvitationExpiryDays: integerClientOrganizationid: Id · مطلوبorganizationId: Id · مطلوبname: string · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/projects/{projectId}/client-requestslistClientRequestsorganizationId · path · string (uuid) · مطلوبprojectId · path · string (uuid) · مطلوبcursor · query · stringstatus · query · ClientRequestStatus200 · ClientRequestPage Authorized requestsClientRequestPageitems: ClientRequest[] · مطلوبnextCursor: string | null/organizations/{organizationId}/projects/{projectId}/client-requestscreateClientRequestorganizationId · path · string (uuid) · مطلوبprojectId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateClientRequestRequest201 · ClientRequest Request submitted; desired date is not committed403 · Error Principal lacks capability; response does not reveal hidden object details.422 · Error Invalid request or transition.CreateClientRequestRequesttitle: string · مطلوبdescription: object · مطلوبcategory: stringurgencyReason: stringdesiredAt: one offileAssetIds: Id[]ClientRequestid: Id · مطلوبprojectId: Id · مطلوبtitle: string · مطلوبdescription: objectstatus: ClientRequestStatus · مطلوبdesiredAt: one ofcommittedAt: one ofclientSafeReason: stringacceptedWorkItemId: one ofversion: integer · مطلوبcreatedAt: Timestamp · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/client-requests/{requestId}getClientRequestorganizationId · path · string (uuid) · مطلوبrequestId · path · string (uuid) · مطلوب200 · ClientRequest Client-safe or internal projection according to principal404 · Error Object absent or intentionally indistinguishable from inaccessible.ClientRequestid: Id · مطلوبprojectId: Id · مطلوبtitle: string · مطلوبdescription: objectstatus: ClientRequestStatus · مطلوبdesiredAt: one ofcommittedAt: one ofclientSafeReason: stringacceptedWorkItemId: one ofversion: integer · مطلوبcreatedAt: Timestamp · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/client-requests/{requestId}/transitionstransitionClientRequestorganizationId · path · string (uuid) · مطلوبrequestId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبTransitionClientRequest200 · ClientRequest Transition applied with audit event409 · Error Version, state, or idempotency fingerprint conflict.422 · Error Invalid request or transition.TransitionClientRequesttoStatus: ClientRequestStatus · مطلوبexpectedVersion: integer · مطلوبclientSafeReason: stringcommittedAt: one ofacceptedWork: one ofClientRequestid: Id · مطلوبprojectId: Id · مطلوبtitle: string · مطلوبdescription: objectstatus: ClientRequestStatus · مطلوبdesiredAt: one ofcommittedAt: one ofclientSafeReason: stringacceptedWorkItemId: one ofversion: integer · مطلوبcreatedAt: Timestamp · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/conversations/{conversationId}/messagescreateMessageorganizationId · path · string (uuid) · مطلوبconversationId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateMessageRequest201 · Message Message committed and assigned a sequenceCreateMessageRequestcontent: object · مطلوبparentMessageId: one ofclientGeneratedId: string · مطلوبMessageid: Id · مطلوبconversationId: Id · مطلوبauthorUserId: Id · مطلوبsequenceNo: integer · مطلوبcontent: object · مطلوبaudience: Audience · مطلوبcreatedAt: Timestamp · مطلوب/organizations/{organizationId}/messages/{messageId}/convertconvertMessageToWorkorganizationId · path · string (uuid) · مطلوبmessageId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبConvertMessageRequest201 · WorkItem Linked work item created without copying source context409 · Error Existing conversion returned or request fingerprint conflictWorkItemid: Id · مطلوبprojectId: Id · مطلوبsourceMessageId: one oftype: string · مطلوبtitle: string · مطلوبstate: string · مطلوبownerUserId: one ofdueAt: one ofaudience: Audience · مطلوبversion: integer · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/projects/{projectId}/work-itemscreateWorkItemorganizationId · path · string (uuid) · مطلوبprojectId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateWorkItemRequest201 · WorkItem Work item createdCreateWorkItemRequesttype: task | milestone | approval | request · مطلوبtitle: string · مطلوبstate: backlog | ready | in_progress | blocked | internal_review | done | archived · مطلوبownerUserId: one ofdueAt: one ofaudience: Audience · مطلوبWorkItemid: Id · مطلوبprojectId: Id · مطلوبsourceMessageId: one oftype: string · مطلوبtitle: string · مطلوبstate: string · مطلوبownerUserId: one ofdueAt: one ofaudience: Audience · مطلوبversion: integer · مطلوب/organizations/{organizationId}/work-items/{workItemId}updateWorkItemorganizationId · path · string (uuid) · مطلوبworkItemId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبUpdateWorkItemRequest200 · WorkItem Updated with optimistic version increment409 · Error Version, state, or idempotency fingerprint conflict.UpdateWorkItemRequestexpectedVersion: integer · مطلوبtitle: stringstate: stringownerUserId: one ofdueAt: one ofaudience: AudiencetransitionReason: stringWorkItemid: Id · مطلوبprojectId: Id · مطلوبsourceMessageId: one oftype: string · مطلوبtitle: string · مطلوبstate: string · مطلوبownerUserId: one ofdueAt: one ofaudience: Audience · مطلوبversion: integer · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/upload-sessionscreateUploadSessionorganizationId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateUploadSessionRequest201 · UploadSession Scoped multipart upload sessionCreateUploadSessionRequestfileName: string · مطلوبmimeType: string · مطلوبsizeBytes: integer · مطلوبcontentHash: stringpurpose: message_attachment | request_attachment | deliverable | document · مطلوبobjectId: IdUploadSessionid: Id · مطلوبexpiresAt: Timestamp · مطلوبpartSizeBytes: integer · مطلوبreservedBytes: integer · مطلوبuploadUrls: object[] · مطلوب/organizations/{organizationId}/upload-sessions/{uploadSessionId}/completecompleteUploadSessionorganizationId · path · string (uuid) · مطلوبuploadSessionId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCompleteUploadRequest202 · FileAsset Upload accepted for verification and scanCompleteUploadRequestparts: object[] · مطلوبFileAssetid: Id · مطلوبname: string · مطلوبstatus: created | uploading | uploaded | verifying | scanning | ready | rejected | expired | cancelled · مطلوب/organizations/{organizationId}/projects/{projectId}/deliverablescreateDeliverableorganizationId · path · string (uuid) · مطلوبprojectId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateDeliverableRequest201 · Deliverable Deliverable created internal by defaultCreateDeliverableRequesttitle: string · مطلوبdescription: stringDeliverableid: Id · مطلوبprojectId: Id · مطلوبtitle: string · مطلوبstatus: string · مطلوب/organizations/{organizationId}/deliverables/{deliverableId}/versionscreateDeliverableVersionorganizationId · path · string (uuid) · مطلوبdeliverableId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبCreateDeliverableVersionRequest201 · DeliverableVersion Immutable version created422 · Error Invalid request or transition.CreateDeliverableVersionRequestfileVersionIds: Id[] · مطلوبsummary: string · مطلوبcriteria: string[]DeliverableVersionid: Id · مطلوبdeliverableId: Id · مطلوبversionNo: integer · مطلوبcontentHash: string · مطلوبstatus: string · مطلوبpublishedAt: one ofErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/deliverable-versions/{versionId}/client-previewpreviewClientProjectionorganizationId · path · string (uuid) · مطلوبversionId · path · string (uuid) · مطلوبClientPreviewRequest200 · ClientPreview Real-policy client projection plus warningsClientPreviewRequestclientOrganizationId: Id · مطلوبrole: client_admin | client_reviewer | client_member | client_viewer · مطلوبClientPreviewprojection: object · مطلوبwarnings: object[] · مطلوبpolicyFingerprint: string · مطلوب/organizations/{organizationId}/deliverable-versions/{versionId}/publishpublishDeliverableVersionorganizationId · path · string (uuid) · مطلوبversionId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبPublishDeliverableRequest201 · Approval Client projection and approval created transactionally422 · Error Invalid request or transition.PublishDeliverableRequestclientOrganizationId: Id · مطلوبreviewerUserIds: Id[] · مطلوبapprovalPolicy: all_required | any_one | ordered · مطلوبdueAt: one ofexpectedContentHash: string · مطلوبpolicyFingerprint: string · مطلوبApprovalid: Id · مطلوبdeliverableVersion: DeliverableVersion · مطلوبcontentHash: string · مطلوبstatus: draft | requested | viewed | approved | changes_requested | expired | cancelled | invalidated · مطلوبdueAt: one ofreviewers: object[] · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/approvals/{approvalId}getApprovalorganizationId · path · string (uuid) · مطلوبapprovalId · path · string (uuid) · مطلوب200 · Approval Reviewer-safe exact governed version404 · Error Object absent or intentionally indistinguishable from inaccessible.Approvalid: Id · مطلوبdeliverableVersion: DeliverableVersion · مطلوبcontentHash: string · مطلوبstatus: draft | requested | viewed | approved | changes_requested | expired | cancelled | invalidated · مطلوبdueAt: one ofreviewers: object[] · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/approvals/{approvalId}/decisionsdecideApprovalorganizationId · path · string (uuid) · مطلوبapprovalId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبApprovalDecisionRequest201 · ApprovalDecision Immutable reviewer decision409 · Error Version, state, or idempotency fingerprint conflict.422 · Error Invalid request or transition.ApprovalDecisionRequestdecision: approved | changes_requested · مطلوبexpectedContentHash: string · مطلوبfeedback: object[]ApprovalDecisionid: Id · مطلوبapprovalId: Id · مطلوبreviewerUserId: Id · مطلوبdecision: string · مطلوبcontentHash: string · مطلوبdecidedAt: Timestamp · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object/organizations/{organizationId}/homegetHomeorganizationId · path · string (uuid) · مطلوب200 · Home Permission-filtered My DayHomerecommended: object[]due: WorkItem[]blocked: WorkItem[]waiting: object[]/organizations/{organizationId}/inboxgetInboxorganizationId · path · string (uuid) · مطلوبcursor · query · stringmode · query · important | all | waiting_on_me | client_actions200 · InboxPage Recipient-only notification bundlesInboxPageitems: object[] · مطلوبnextCursor: string | null/organizations/{organizationId}/searchsearchorganizationId · path · string (uuid) · مطلوبq · query · string · مطلوبtype · query · string[]cursor · query · string200 · SearchPage Authorized results onlySearchPageitems: object[] · مطلوبnextCursor: string | null/organizations/{organizationId}/members/{membershipId}/offboarding-impactgetOffboardingImpactorganizationId · path · string (uuid) · مطلوبmembershipId · path · string (uuid) · مطلوب200 · OffboardingImpact Ownership/access impact without executing changesOffboardingImpactactiveSessions: integerownedWorkCount: integerpendingApprovalCount: integerexternalShareCount: integerrequiredTransferTypes: string[]/organizations/{organizationId}/members/{membershipId}/offboardoffboardMemberorganizationId · path · string (uuid) · مطلوبmembershipId · path · string (uuid) · مطلوبIdempotency-Key · header · string · مطلوبOffboardMemberRequest202 · OffboardingJob Membership suspended immediately; transfer workflow startedOffboardMemberRequesttransferToUserId: Id · مطلوبconfirmation: string · مطلوبOffboardingJobid: Id · مطلوبstatus: suspending | transferring | reviewing_external_access | completed | failed_partial · مطلوب/organizations/{organizationId}/audit-eventslistAuditEventsorganizationId · path · string (uuid) · مطلوبcursor · query · stringaction · query · stringactorId · query · string (uuid)200 · AuditPage Scope-redacted audit eventsAuditPageitems: object[] · مطلوبnextCursor: string | null/organizations/{organizationId}/billing/usagegetOrganizationPlanUsageorganizationId · path · string (uuid) · مطلوب200 · OrganizationPlanUsage Authorized workspace plan and usage summary. Client principals and ordinary members cannot read billing data.403 · Error Principal lacks capability; response does not reveal hidden object details.OrganizationPlanUsageplanCode: string · مطلوبplanVersion: integer · مطلوبdimensions: UsageDimension[] · مطلوبclientUsersIncluded: boolean · مطلوبmeasuredAt: Timestamp · مطلوبErrorcode: string · مطلوبmessage: string · مطلوبcorrelationId: Id · مطلوبfieldErrors: object