People With Birthdays

People With Birthdays Documentation

People With Birthday [LIST]

People With Birthday [LIST]

Request

Endpoint

GET /api/v2/reports/people_with_birthdays
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type string

Description The account list to run the report on.

Required No

end_date

Type string

Description The date in which you would like the report to end on. This will be shifted to the end of the final period. Default: today

Required No

range

Type string

Description A string defining the number of periods and how long they should be with an indictor: (d)ay, (w)eek, (m)onth, (y)ear. Examples: 30d, 2w, 12m, 1y. Default: 4m

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "2022-01-09",
      "type": "reports_people_with_birthdays_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "end_date": "2022-01-15",
        "start_date": "2022-01-09",
        "updated_at": null,
        "updated_in_db_at": null
      },
      "relationships": {
        "people": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2022-01-02",
      "type": "reports_people_with_birthdays_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "end_date": "2022-01-08",
        "start_date": "2022-01-02",
        "updated_at": null,
        "updated_in_db_at": null
      },
      "relationships": {
        "people": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2021-12-26",
      "type": "reports_people_with_birthdays_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "end_date": "2022-01-01",
        "start_date": "2021-12-26",
        "updated_at": null,
        "updated_in_db_at": null
      },
      "relationships": {
        "people": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2021-12-19",
      "type": "reports_people_with_birthdays_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:54Z",
        "end_date": "2021-12-25",
        "start_date": "2021-12-19",
        "updated_at": null,
        "updated_in_db_at": null
      },
      "relationships": {
        "people": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [People With Birthdays Period]

Description An array of People With Birthdays Periods