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 allows users to search for organizations associated with distributors using various filter criteria. It supports fetching either a single page or all pages of results, with options to filter by attributes such as creation date, cancellation status, distributor ID, MSP ID, name, and more. This is useful for distributors or MSPs who need to retrieve detailed lists of organizations matching specific conditions, for example, to generate reports or manage organizational data.

Use Case Examples

  1. Fetch all organizations managed by a specific MSP ID.
  2. Search for organizations created within a certain date range.
  3. Retrieve only canceled organizations for auditing purposes.

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.
Additional Fields Optional filters to narrow down the search results, including date ranges for creation, cancellation, transfer, update, and other organization-specific attributes like distributor ID, SKU, status, external ID, MSP ID, name, trial end date, and cancellation inclusion flags.

Output

JSON

  • json - The JSON response containing the list of organizations matching the search criteria.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the API key is valid and has the necessary permissions to access distributor organization data.
  • Check that pagination parameters are correctly set when fetching all results to avoid incomplete data.
  • Verify that date filters are provided as Unix timestamps where required.
  • If the API returns a 429 status, respect the rate limit headers and retry after the specified time.

Links

Discussion