Error Handling Guide
How Agility API errors actually present, and how to handle them: partial failures, violation tags, retries and timeouts
9 docs tagged with "guides"
View all tagsMembers, Roles, and Scopes
How access is granted and read through the API - default-role membership, the AssignWithRole operations, and the Project Roles read API
Payload Patterns Guide
The canonical request shapes for querying, creating, updating and operating on Agility assets
Performance Best Practices
Decision-level performance guidance for Agility integrations: what to cache, when to batch, how much to parallelize
Rate Limiting
How Agility enforces API rate limits, how to check configured quota policies, and which endpoints expose usage metrics
Reproducing Reported Numbers
Why a figure in Agility does not match the one your query returns, and how to reconstruct the calculation behind it — using velocity as the worked example.
Scope Context and Filtering
The scope context - how Agility narrows the Scope hierarchy for filtering, and how Rooms embody it
System Names and Display Names
Mapping between what the UI shows and what the API calls things, using meta.v1 and the localization API
Working with Comments
Conversations, Expressions and Mentions - the model behind comments, and how to create, reply to and read them through the API