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 users associated with a specified organization from the DNSFilter API. It supports retrieving all users or a single page of results, with options to include additional data such as authentication providers. This is useful for managing and auditing organization users, for example, to list all users in an organization or to get detailed user information including their authentication methods.

Use Case Examples

  1. Retrieve all users for organization ID 12345, including their authentication providers.
  2. Fetch a single page of users for organization ID 67890 without additional authentication provider details.

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.
Organization Id The ID of the organization to search for users.
Additional Fields Optional fields to include in the request, such as whether to include user's authentication providers.

Output

JSON

  • json - The JSON response containing user data from the API.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the organization ID is valid and the API key has permissions to access organization user data.
  • If pagination is enabled, verify pagination parameters are correctly set to avoid incomplete data.
  • Check for API rate limits and handle HTTP 429 responses by respecting Retry-After headers.
  • Enable debug option to see the actual request URL, headers, and body for troubleshooting.

Links

Discussion