Test safely before you go live

Try the API in your own workspace, with a key that can do only what your test needs, on a company you keep for testing. Then the only tickets your tool changes are your own test ones.

1. 1
   Make a test agent

   A tenant admin opens the API agents section of Settings › Users and roles › People and chooses Add agent. Name it for the test (for example "Integration test") so its changes are easy to spot in a ticket's history.
2. 2
   Give its key only what it needs

   Create a token with only the scopes your tool uses, the shortest expiry that covers the test, and an allowed address list that holds only the address your tool calls from (see Authentication). A key that changes tickets must have one.
3. 3
   Make a test company

   Create a company whose name starts ZZ-Current Test, for example ZZ-Current Test Dental, and open a few tickets on it. Point your tool at that company and its tickets only.
4. 4
   Revoke the test key

   When your tool works, give it a key of its own for real use and revoke the test key on the API access page.

curl -sS --fail-with-body "https://api.current.day/v1/tickets?company_id=c2e9a0f4-1b7d-4c35-a8e6-5d3f7b1c9e02&limit=5" \
  -H "Authorization: Bearer $CURRENT_API_KEY"

• Reads change nothing. Searching and reading tickets, boards and companies is safe on your real data, and a key sees only what its agent's role may see.
• Ticket changes need the tickets:write scope. If Create token offers no tickets:write scope, ticket changes are not switched on yet and your key can only read.
• An agent's change runs exactly as a person's would. Notes it adds are internal, and Current emails no customer about it (see Agent closes for the one setting that can).
• A ticket linked to your PSA gets an agent's change as it would a person's. In Test mode Current sends ticket changes to your PSA only for a company whose name in your PSA starts ZZ-Current Test, and keeps every other change in Current. Once changes go to your PSA for every company, test on a company that is a ZZ-Current Test company in your PSA too.