Skip to main content

persons

Get all persons registered in the system, optionally filtered by company or brand.

persons(
after: String
before: String
brandId: ID
companyId: ID
filters: PersonFilterInput
first: Int
last: Int
): PartyConnection!

Arguments

persons.after ● String scalar

Returns the elements in the list that come after the specified cursor.

persons.before ● String scalar

Returns the elements in the list that come before the specified cursor.

persons.brandId ● ID scalar

The brand ID to search for persons.

persons.companyId ● ID scalar

The company party ID to search for persons. This argument has precedence over the brandId argument.

persons.filters ● PersonFilterInput input

Filter persons by the given criteria.

persons.first ● Int scalar

Returns the first _n_ elements from the list.

persons.last ● Int scalar

Returns the last _n_ elements from the list.

Type

PartyConnection object

The connection type for Party.