Get reference set content

To get the content of a reference set in your Connect subscription, query the referenceSetRecords object.

query {
    referenceSetRecords(dataSetId: "123456789-0000000000000000000"){
        totalCount
        nodes {
            attributes {
                name
                value
            }
        }
    }
}
{
    "data": {
        "referenceSetRecords": {
            "totalCount": 3,
            "nodes": [
                {
                    "attributes": [
                        {
                            "name": "Email",
                            "value": "[email protected]"
                        },
                        {
                            "name": "Age",
                            "value": "14-17"
                        },
                        {
                            "name": "Nearest store",
                            "value": "Bremen"
                        },
                        {
                            "name": "Client",
                            "value": true
                        },
                        {
                            "name": "ID",
                            "value": "OYXF-761"
                        },
                        {
                            "name": "Joined on",
                            "value": "2024-10-10 13:59:31.000"
                        }
                    ]
                },
                {
                    "attributes": [
                        {
                            "name": "Email",
                            "value": "[email protected]"
                        },
                        {
                            "name": "Age",
                            "value": "18-24"
                        },
                        {
                            "name": "Nearest store",
                            "value": "Bremen"
                        },
                        {
                            "name": "Client",
                            "value": true
                        },
                        {
                            "name": "ID",
                            "value": "OYXF-87"
                        },
                        {
                            "name": "Joined on",
                            "value": "2022-10-10 13:59:31.000"
                        }
                    ]
                },
                {
                    "attributes": [
                        {
                            "name": "Email",
                            "value": "[email protected]"
                        },
                        {
                            "name": "Age",
                            "value": "18-24"
                        },
                        {
                            "name": "Nearest store",
                            "value": "Karlskrona"
                        },
                        {
                            "name": "Client",
                            "value": true
                        },
                        {
                            "name": "ID",
                            "value": "OYXF-88"
                        },
                        {
                            "name": "Joined on",
                            "value": "2024-11-10 13:59:31.000"
                        }
                    ]
                }
            ]
        }
    }
}

Arguments

Arguments supported by the referenceSetRecords query

ArgumentNested fieldValuesRequired?Definition
dataSetIdIDRequiredThe ID of the reference set
filterfieldOptional
containsOptional"Contains the specified text"
eqOptional"Equals."
inOptional"Is one of the following."
orderByfieldStringOptional
sort

Either of the following values:

- ASC
- DESC

OptionalThe sort order to use for reference sets in the response

Fields

Fields returned by the referenceSetRecords query

FieldNested fieldValuesRequired?Description
nodesattributesArrayRequiredSee nested fields
totalCountIntegerOptionalThe total number of entries in the reference set

Fields nested into the attributes field

FieldValuesRequired?Description
nameStringRequiredThe name of an attribute defined in the reference set
valueDepends on the attribute typeOptionalThe value assigned to the attribute
type

One of the following values:

- TEXT
- NUMBER
- BOOLEAN
- DATE

OptionalThe data format of the attribute