Help

Reference

Facts to look up: endpoints, fields, permissions and limits.

Pages

  • Authentication and permissions: How API tokens work, the four API permissions, and which records a token can see.

  • Requests, errors and limits: Pagination, request bodies, error bodies, money and date formats, idempotency keys, and rate limits for the Drum API.

  • Accounts and me: Read the token’s user, and list the Drum accounts that user belongs to.

  • Projects: List and read delivery projects, with their deliverables, tasks, contacts, addresses and custom fields.

  • Tasks: Change the status, dates, note and assigned members of one task on a project or opportunity.

  • Opportunities: List, read, create, update and convert sales opportunities, and edit their deliverables and tasks.

  • Tracked times: Read, log, change and delete time entries on projects, and leave, overhead and time credit time.

  • Costs: Read, create and change project costs and their line items, add expense claim receipts, and attach files.

  • Invoices and write-offs: Read invoices and write-offs, and allocate an existing Xero invoice to a project.

  • Planned invoices: Read the invoices a firm plans to raise on its projects.

  • Lookup lists: The lists an integration reads to find valid ids, such as statuses, lead scores, cost types, finance accounts and members.

  • Companies and contacts: List, read, create, change and merge companies, and manage contacts and their links to companies, opportunities and projects.

  • Notes: List, read, add, change, delete and restore the notes on a project, opportunity, company, contact or other record.

  • Proposals: Read a live proposal, edit its proposal document, read its sent versions, send it by email, and read the client’s signed answers.

  • Proposal budgets: Add, change and delete the phases, deliverables, tasks, resource lines and cost lines of a live proposal’s budget, one row at a time.

  • Account settings: Read an account’s setup catalog, change Project Settings and Opportunity Settings, and set proposal numbering. Also the rules shared by every setup endpoint.

  • Templates: Read, create, change, delete and restore deliverable templates and project templates, and edit their tasks, lines, phases, statuses, lead scores and custom fields one row at a time.

  • Proposal templates: Read, create, change, delete and restore proposal templates, and edit their quote sections, notes, custom rate card and budget.

  • Settings catalogs: List, read, create, change, delete and restore custom fields, resource types, cost types, rate cards, project roles, booking types and milestone types.