Skip to main content
GET
/
api
/
v1
/
feeds
Get a list of feeds
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/feeds \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 3
  },
  "response": [
    {
      "carrier_id": "6ccec769-aaf5-4cb0-92f0-f16b9500c21d",
      "configuration": {
        "cadence": {
          "end_date": "2025-03-01",
          "next_transmission": "2024-09-10T10:00:00+00:00",
          "paused": true,
          "rrule": "RRULE:FREQ=DAILY",
          "start_date": "2024-03-01",
          "time_of_day": "06:00",
          "zone_info": "US/Eastern"
        }
      },
      "created": 1690395918,
      "group_id": "594ca3ab-4f98-4ec6-8158-ed59f7f96fe2",
      "id": "00ffa55b-84e1-48d7-8587-57103c10903f",
      "last_transmission": {
        "id": "bda1b068-3e6a-4cc3-9769-0fb8a38649ce",
        "sent_timestamp": 1641171601
      },
      "modified": 1690395918,
      "name": "feed-me",
      "next_transmission": 1641171601,
      "paused": false,
      "status": "active",
      "version": "49ed5785-d8e1-4c3d-a09d-2f3625b9f2b1"
    },
    {
      "carrier_id": "6ccec769-aaf5-4cb0-92f0-f16b9500c21d",
      "configuration": {
        "cadence": {
          "end_date": "2025-03-01",
          "next_transmission": "2024-09-10T10:00:00+00:00",
          "paused": true,
          "rrule": "RRULE:FREQ=DAILY",
          "start_date": "2024-03-01",
          "time_of_day": "06:00",
          "zone_info": "US/Eastern"
        }
      },
      "created": 1690395919,
      "group_id": "594ca3ab-4f98-4ec6-8158-ed59f7f96fe2",
      "id": "3b6e4933-c45a-4320-9770-06d6da1f035a",
      "last_transmission": {
        "id": "bda1b068-3e6a-4cc3-9769-0fb8a38649ce",
        "sent_timestamp": 1641171601
      },
      "modified": 1690395919,
      "name": "feed-you",
      "next_transmission": 1641171601,
      "paused": false,
      "status": "retired",
      "version": "3e93d0ec-4666-4cb5-9780-7f451a309754"
    },
    {
      "carrier_id": "6ccec769-aaf5-4cb0-92f0-f16b9500c21d",
      "configuration": {
        "cadence": {
          "end_date": "2025-03-01",
          "next_transmission": "2024-09-10T10:00:00+00:00",
          "paused": true,
          "rrule": "RRULE:FREQ=DAILY",
          "start_date": "2024-03-01",
          "time_of_day": "06:00",
          "zone_info": "US/Eastern"
        }
      },
      "created": 1690395920,
      "group_id": "594ca3ab-4f98-4ec6-8158-ed59f7f96fe2",
      "id": "2d8ce8c4-623f-4aae-8bdc-5a730f523172",
      "last_transmission": {
        "id": "bda1b068-3e6a-4cc3-9769-0fb8a38649ce",
        "sent_timestamp": 1641171601
      },
      "modified": 1690395920,
      "name": "feed-who",
      "next_transmission": 1641171601,
      "paused": true,
      "status": "template",
      "version": "bf2039f2-b9e1-460e-8d67-c2083ef352a7"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
group_id
string<uuid>

Unique identifier of the group

​
carrier_id
string<uuid>

Unique identifier of the carrier

​
next_transmission_end
string

Filter by feeds that will run before the provided datetime

​
paused
boolean

Filter by feeds that are temporarily paused from delivering files

​
status
string

Filter by feed status

​
testing
boolean

Filter by feeds that are in a testing state with the carrier

​
feed
string

Filter by feed name or feed ID

​
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

​
sort_by
string

The attribute on which to sort

​
sort_direction
string

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

Response

200 - application/json

Successful Response - Returns all matching feeds

​
meta
object
required

Metadata associated with the response data

​
response
object[]
required

List of feeds with public data