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 belonging to a specific collection identified by a collection ID. It supports pagination and filtering by user name, allowing retrieval of either all users or a single page of users within the collection. This is useful for managing and viewing users associated with a particular collection in DNSFilter.

Use Case Examples

  1. Retrieve all users in a collection with ID 12345, including pagination to get all pages.
  2. Fetch a single page of users in collection ID 12345, filtered by user name 'john.doe'.
  3. Sort users in a collection by name and return all results.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Collection Id The ID of the collection to fetch users from.
Additional Fields Optional filters and pagination settings such as name filter, page number and size, and sort options.

Output

JSON

  • json - The JSON response containing the list of users in the specified collection.

Dependencies

  • An API key credential for DNSFilter to authenticate API requests.

Troubleshooting

  • Ensure the collection ID is valid and accessible with the provided API key.
  • If pagination is enabled, verify that the pagination parameters are correctly set to avoid incomplete data.
  • Check for API rate limits and handle 429 HTTP status responses by respecting Retry-After headers.
  • Enable debug option to see the actual URL, query parameters, headers, and body sent for each API request to troubleshoot issues.

Links

Discussion