API Reference

API Access

API requests should be POST requests with the following components:

  1. Make requests to the appropriate url at https://{server}-api.affluent.io
    1. The {server} placeholder should be substituted with the subdomain of the URL you use to access the Affluent dashboard. For instance, if you log in at "dundermifflin.affluent.io" then you should replace {server} with "dundermifflin"
  2. Add your API key in a query parameter named apiKey. Your API key will be emailed to you upon request. In our next release, creating/refreshing/deleting API keys in the UI will be supported.
  3. Set the Content-Type header to application/json
  4. Include a JSON body with the request parameters. (See Samples for an example)