1. Documentation
  2. Reference-Data API
  3. GET reference-data

GET reference-data

Overview

The Reference-Data API permits interaction with existing custom data tables associated with your company. You can use the API's GET /v2/reference-data call to return an array of available reference-data datasets, and summary information about each dataset.

Resource URI

GEThttps://api.yesmail.com/v2/reference-data

Call Description

The GET /v2/reference-data call returns an array of available reference-data datasets, and summary information about each dataset.

HTTP Return Codes

Code

Description

200 OK

The request has succeeded.

401 Unauthorized

The request requires user authentication.  Invalid Api-User and/or Api-Key header value.

 

Response Payload: 
{
    "datasetCount": 3,
    "datasets":  [
        {
            "name": "table-a",
            "recordCount": 123
        },
        {
            "name": "table-b",
            "recordCount": 234
        },        
        {
            "name": "table-c",
            "recordCount": 345
        }    
    ]
 }