DNSFilter icon

DNSFilter

**Note:** If you are a distributor integrating with DNSFilter, please check out our [Distributors Development Guide](/docs/distributors).### Authentication- Authentication is required for most, but not all, endpoints.- Authentication is done by setting the `Authorization` request header. The header value is the API key itself. For example: `Authorization: eyJ...`- An API key can be obtained through the DNSFilter dashboard under Account Settings. For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/21169189058323-API-Tokens).### Rate Limiting- All endpoints are rate limited.- The limits may vary by endpoint, but are generally consistent.- When the rate limit is exceeded the API will return the standard `429` HTTP status.- The following headers will also be provided in the response: `Retry-After`, `RateLimit-Policy`, `RateLimit`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`. For details on the values of these headers, see the following articles [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After), [here](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-08.html), and [here](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-05.html).- For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/38202811088403-API-Rate-Limits).### Error Handling- The API uses standard HTTP status codes to indicate success or failure.- For _V1_ endpoints the response format is: ```json { "error": "string", "type": "string(optional)" } ```- For _V2_ endpoints the response format is: ```json { "error": { "message": "string", "type": "string(optional)" } } ```### PaginationFor the _V1_ endpoints, the pagination parameters are nested. That is to say,if passed as JSON they look like this: `{"page[number]": 1, "page[size]": 10}`.To pass this information in the URL query string, it would be formatted likethis: `...?page%5Bnumber%5D=1&page%5Bsize%5D=10`.In this guide, the UI will indicate that `page` is an `object` and if youwant to set values when trying the request, you must enter it as if it wasthe JSON above.### A Quick ExampleThe following will return information about the currentlyauthenticated user.```bash% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self{ "data": { "id": "12345", "type": "users", "attributes": { "name": "John Doe", "email": "john@example.com", ...additional fields...}}}```
Join our community

Actions328

Overview

This node operation fetches all user records from the DNSFilter API. It supports retrieving either a single page of users or all users across multiple pages, depending on the 'Return All' parameter. Users can specify pagination details and additional query parameters to filter or customize the request. This operation is useful for scenarios where you need to list all users in an organization or system, such as for auditing, reporting, or synchronization purposes.

Use Case Examples

  1. Retrieve all users in an organization for reporting.
  2. Fetch a single page of users to display in a dashboard.
  3. Use pagination parameters to control the number of users returned per request.

Properties

Name Meaning
Return All Whether to return all user results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields Optional additional parameters such as page number and size to control pagination.

Output

JSON

  • id - User ID
  • name - User's name
  • email - User's email address
  • role - User's role or permissions
  • status - User's account status
  • created_at - Timestamp when the user was created
  • updated_at - Timestamp when the user was last updated

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the API key is valid and has the necessary permissions to access user data.
  • Check network connectivity to the DNSFilter API endpoint.
  • If pagination is enabled, verify that pagination parameters are correctly set to avoid incomplete data.
  • Review error messages returned by the API for specific issues such as rate limiting or invalid parameters.

Links

Discussion