Skip to main content

customAttributeValues

Returns the closed set of values declared for one custom attribute.

Equivalent to looking up customAttribute.values for a single (scope, key) pair without paginating through organization.customAttributes. Useful for populating a single dropdown (e.g. a TEAM picker) by key.

Returns a NOT_FOUND error when (scope, key) does not correspond to a declared custom attribute in the organization.

customAttributeValues(
  organizationId: ID!
  scope: AttributeScope!
  key: String!
): [String!]!

Arguments​

customAttributeValues.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

customAttributeValues.scope ● AttributeScope! non-null enum {#scope}​

The custom attribute's declared scope (matches customAttribute.scope).

customAttributeValues.key ● String! non-null scalar {#key}​

The custom attribute's key (matches customAttribute.key).

Type​

String scalar​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.