API overview and authentication

Ariyes has a public REST API so you can automate your workspace and integrate it with your own systems — for example, syncing contacts or enrolling people into sequences programmatically.

Authentication

Every request is authenticated with a Bearer token — an API key you generate in your workspace. Include it on each call:

Authorization: Bearer ariyes_...

All Ariyes API keys start with the ariyes_ prefix. Requests without a valid key are rejected.

Scopes

Keys are scoped so you can grant only what an integration needs:

  • read — read-only access.
  • write — read and write.
  • full — everything.

Give each integration its own key with the narrowest scope that does the job. The next articles cover creating keys and where to find the full endpoint reference.

Was this page helpful?