List Differences

GET

api

differences

curl --request GET \
  --url https://tracking.noyo.com/api/v1/differences

{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 2,
    "total_records": 97
  },
  "response": [
    {
      "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
      "created": 1698264758,
      "difference_classification": "field_mismatch",
      "difference_type": "dob",
      "discrepancy_time": 1698265273,
      "employee_id": "556f553b-4626-419c-b26e-30bb69956eb0",
      "fields": [
        {
          "carrier_value": "1989-01-12",
          "key": "person.date_of_birth",
          "platform_value": "1999-01-12"
        }
      ],
      "group_id": "26faa540-9ca3-454b-914e-a84701ea04cd",
      "id": "ac951a10-5115-4f1b-a374-5510d818fd07",
      "impact_score": 3,
      "is_dismissed": false,
      "is_suppressed": false,
      "modified": 1706815155,
      "object_id": "d1898ad7-02f8-414f-9f94-5a1acd535c08",
      "object_type": "dependent",
      "organization_id": "34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c",
      "resolved": 1706815154,
      "version": "be22f69e-84b5-4cb0-a66a-a763641861c1"
    },
    {
      "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
      "created": 1698264983,
      "difference_classification": "field_mismatch",
      "difference_type": "ie_effective_end_date",
      "discrepancy_time": 1698265071,
      "employee_id": "05da283a-bf0c-4fb6-b3ca-d658350f0ee2",
      "fields": [
        {
          "carrier_value": "2023-10-31",
          "key": "effective_end_date",
          "platform_value": "9999-12-31"
        }
      ],
      "group_id": "26faa540-9ca3-454b-914e-a84701ea04cd",
      "id": "21150bdf-478a-4ac8-a214-bdd413df984e",
      "impact_score": 3,
      "is_dismissed": false,
      "is_suppressed": false,
      "modified": 1707342911,
      "object_id": "751437b9-1380-485f-937b-d86cec916f3e",
      "object_type": "individual_enrollment",
      "organization_id": "34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c",
      "resolved": 1707342908,
      "version": "44707efe-3900-48dc-a243-e9d3c0781f40"
    }
  ]
}

Query Parameters

page_size

integer

The max size of each page of results

offset

integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

string

Comma-separated list of requested Difference UUIDs

max_impact_score

integer

Filter out differences above this impact score

min_impact_score

integer

Filter out differences below this impact score

is_open

boolean

True if you want differences that still need to be resolved

object_type

string

Comma separated object types you would like to filter on

object_id

string

The ID of the object you'd like to filter on

group_id

string

The ID of the group you'd like to filter on

created_before

string

Filter for only differences created before this date (exclusive)

created_after

string

Filter for only differences created after this date (exclusive)

impact_type

string

Comma separated impact types you would like to filter on

is_dismissed

boolean

show only differences with the given is_dismissed value

is_discrepancy

boolean

Show only differences that are or are not discrepancies

member_snapshot_id

string

The ID of the member snapshot you'd like to filter on

sort_by

string

The attribute on which to sort

sort_direction

string

Either asc or desc, to denote the data's direction

include_unavailable

boolean

Include differences that are known to be unavailable at carrier

classification

string

Comma separated difference classifications to filter differences by

type

string

Comma separated difference types to filter differences by

Response

200 - application/json

Successful Response - Returns all matching differences

meta

object

required

Metadata associated with the response data

response

object[]

required

List of difference results

response.carrier_id

string

required

Unique identifier of the carrier in Noyo

response.created

integer

required

The date the record was created

response.difference_classification

string

required

Describes the way in which the carrier and platform values differ. One of: missing_from_carrier, field_mismatch, missing_from_platform

response.difference_type

string

required

Describes the specific type of data the difference is for

response.employee_id

string

required

Unique identifier of the employee whose family is associated with this difference

response.fields

object[]

required

The difference fields that are different between the platform and carrier

response.group_id

string

required

Unique identifier of the group in Noyo

response.id

string

required

Unique identifier of the record in Noyo

response.impact_score

integer

required

A numerical score describing the impact of the difference

response.is_dismissed

boolean

required

Has this difference been dismissed by the user?

response.is_suppressed

boolean

required

Has this difference been suppressed by noyo?

response.modified

integer

required

The date the record was last updated

response.object_id

string

required

Unique identifier associated with the object

response.object_type

string

required

Type of the object. One of: dependent, employee, individual_enrollment

response.version

string

required

Current version of the record

response.discrepancy_time

integer

If the difference has become a discrepancy, the time at which that happened

response.impact_type

string | null

Describes the type of impact this difference has

response.replaced_by

string | null

Unique identifier of the replacing difference

response.resolved

integer | null

The date the difference was resolved

Was this page helpful?

Get Employee Status Get Difference

curl --request GET \
  --url https://tracking.noyo.com/api/v1/differences

{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 2,
    "total_records": 97
  },
  "response": [
    {
      "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
      "created": 1698264758,
      "difference_classification": "field_mismatch",
      "difference_type": "dob",
      "discrepancy_time": 1698265273,
      "employee_id": "556f553b-4626-419c-b26e-30bb69956eb0",
      "fields": [
        {
          "carrier_value": "1989-01-12",
          "key": "person.date_of_birth",
          "platform_value": "1999-01-12"
        }
      ],
      "group_id": "26faa540-9ca3-454b-914e-a84701ea04cd",
      "id": "ac951a10-5115-4f1b-a374-5510d818fd07",
      "impact_score": 3,
      "is_dismissed": false,
      "is_suppressed": false,
      "modified": 1706815155,
      "object_id": "d1898ad7-02f8-414f-9f94-5a1acd535c08",
      "object_type": "dependent",
      "organization_id": "34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c",
      "resolved": 1706815154,
      "version": "be22f69e-84b5-4cb0-a66a-a763641861c1"
    },
    {
      "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
      "created": 1698264983,
      "difference_classification": "field_mismatch",
      "difference_type": "ie_effective_end_date",
      "discrepancy_time": 1698265071,
      "employee_id": "05da283a-bf0c-4fb6-b3ca-d658350f0ee2",
      "fields": [
        {
          "carrier_value": "2023-10-31",
          "key": "effective_end_date",
          "platform_value": "9999-12-31"
        }
      ],
      "group_id": "26faa540-9ca3-454b-914e-a84701ea04cd",
      "id": "21150bdf-478a-4ac8-a214-bdd413df984e",
      "impact_score": 3,
      "is_dismissed": false,
      "is_suppressed": false,
      "modified": 1707342911,
      "object_id": "751437b9-1380-485f-937b-d86cec916f3e",
      "object_type": "individual_enrollment",
      "organization_id": "34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c",
      "resolved": 1707342908,
      "version": "44707efe-3900-48dc-a243-e9d3c0781f40"
    }
  ]
}

Groups

Members

Changes

Legacy

Query Parameters

Response