Use the GetPaidX API with a personal access token
Create a personal access token from the UI and use it as the bridge from manual usage into automation.
This walkthrough treats the PAT as the next step after understanding the UI, not as a replacement for learning the product.
What this walkthrough covers
What this feature does
This walkthrough turns a normal signed-in account into an account that can also automate product flows through the API.
Why people use it
The token is useful when you want to:
- repeat a UI action programmatically,
- trigger a flow from a script or another tool,
- connect the same account to workspace-based automation.
What to do immediately after
After creating the token, the most useful next step is to inspect the live API surface and pick the exact route that maps to the task you already understand from the UI.
Step-by-step
How the flow works
Step 1
Open Personal Access Tokens in settings
Goal: Go to the self-serve place where API access begins.
Why it matters: The product keeps token creation in the app so advanced users do not need manual provisioning.
Route: /settings/api
This step starts at the exact in-product screen where personal API access begins.
Step 2
Create a new token
Goal: Generate the bearer token you will use for API requests.
Why it matters: This is the exact bridge from app usage into automation.
Route: /settings/api
The walkthrough captures the actual token creation step, not just the static settings page.
Step 3
Use the token with the programmatic API catalog
Goal: Move immediately from token creation into discovering the available endpoints.
Why it matters: A token is only useful once it is paired with the endpoint surface you actually intend to automate.
Route: /settings/api
The final step captures the moment where the token is ready to be used with the programmatic API surface.
Common questions
What people usually ask
When should I use a PAT instead of just using the app UI?
Use a PAT when you already understand the UI flow and want to repeat it programmatically, integrate it into another process, or use it inside a workspace.
Do I need to understand every API route before creating a token?
No. The practical next step is to create the token and then inspect the machine-readable catalog for the routes you actually need.
What happens next
Once this walkthrough makes sense, move directly into the next related flow instead of stopping at the explanation layer.