GraphQL filter location list by contacts #11573

New Issue

adam · 2025-12-29T21:47:01+01:00

adam commented

2025-12-29 21:47:01 +01:00

Originally created by @llamafilm on GitHub (Sep 4, 2025).

Originally assigned to: @llamafilm on GitHub.

NetBox version

v4.3.2

Feature type

New functionality

Proposed functionality

Using GraphQL, I would like to be able to filter the location_list by assigned contacts. For example:

{
  location_list(
    filters:{
      site: {name: {exact:"LA-LAI"}}
      contacts: {name: {exact:"MSE"}}
    }) {
    id
  }
}

This query fails with error

Unsupported lookup 'name__exact' for GenericRel or join on the field not permitted.

Use case

We use contacts to define which team is responsible for supporting each location. I want to build a Grafana dashboard to visualize how many rooms are supported by each team.

Database changes

No response

External dependencies

No response

Originally created by @llamafilm on GitHub (Sep 4, 2025). Originally assigned to: @llamafilm on GitHub. ### NetBox version v4.3.2 ### Feature type New functionality ### Proposed functionality Using GraphQL, I would like to be able to filter the `location_list` by assigned contacts. For example: ``` { location_list( filters:{ site: {name: {exact:"LA-LAI"}} contacts: {name: {exact:"MSE"}} }) { id } } ``` This query fails with error > Unsupported lookup 'name__exact' for GenericRel or join on the field not permitted. ### Use case We use contacts to define which team is responsible for supporting each location. I want to build a Grafana dashboard to visualize how many rooms are supported by each team. ### Database changes _No response_ ### External dependencies _No response_

adam added the type: bug status: accepted severity: low labels 2025-12-29 21:47:01 +01:00

adam closed this issue

2025-12-29 21:47:01 +01:00

adam commented

2025-12-29 21:47:02 +01:00

@llamafilm commented on GitHub (Sep 6, 2025):

I see ContactFilterMixin is already defined so I guess this was intended to work, but it doesn't. I volunteer to fix it.

@llamafilm commented on GitHub (Sep 6, 2025): I see `ContactFilterMixin` is already defined so I guess this was intended to work, but it doesn't. I volunteer to fix it.

adam commented

2025-12-29 21:47:03 +01:00

@jeremystretch commented on GitHub (Sep 19, 2025):

I'm reclassifying this as a bug, because the current filter definition for contacts is incorrect as pointed out by @llamafilm here. The filter exists but does not function as expected:

{
  site_list(
    filters:{
      contacts: {
        name: {
          exact: "Dwight Schrute"
        }
      }
    }
  ) {
    name
  }
}

The above GraphQL query yields the following error:

{
  "data": null,
  "errors": [
    {
      "message": "Unsupported lookup 'name__exact' for GenericRel or join on the field not permitted.",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "site_list"
      ]
    }
  ]
}

The error indicates that the filter is applied to the generic relation to ContactAssignment, rather than to the Contact itself. With the change proposed in PR #20288, the query can be adapted as follows:

{
  site_list(
    filters:{
      contacts: {
        contact: {
          name: {
            exact: "Dwight Schrute"
          }
        }
      }
    }
  ) {
    name
  }
}

This returns the expected result:

{
  "data": {
    "site_list": [
      {
        "name": "DM-Scranton"
      }
    ]
  }
}

@jeremystretch commented on GitHub (Sep 19, 2025): I'm reclassifying this as a bug, because the current filter definition for `contacts` is incorrect as pointed out by @llamafilm [here](https://github.com/netbox-community/netbox/pull/20288#issuecomment-3301329073). The filter exists but does not function as expected: ```graphql { site_list( filters:{ contacts: { name: { exact: "Dwight Schrute" } } } ) { name } } ``` The above GraphQL query yields the following error: ```json { "data": null, "errors": [ { "message": "Unsupported lookup 'name__exact' for GenericRel or join on the field not permitted.", "locations": [ { "line": 2, "column": 3 } ], "path": [ "site_list" ] } ] } ``` The error indicates that the filter is applied to the generic relation to ContactAssignment, rather than to the Contact itself. With the change proposed in PR #20288, the query can be adapted as follows: ```graphql { site_list( filters:{ contacts: { contact: { name: { exact: "Dwight Schrute" } } } } ) { name } } ``` This returns the expected result: ```json { "data": { "site_list": [ { "name": "DM-Scranton" } ] } } ```

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#11573