> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangrovesystems.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List all data requests for a project

> Returns a paginated list of the project's data requests. Filterable fields: `friendly_id`, `name`, `role`, `sent_at`, `created_at`, `updated_at`. Requires the `read:project` and `read:data_request` token scopes.



## OpenAPI

````yaml GET /projects/{project_id}/data_requests
openapi: 3.1.0
info:
  title: Mangrove - API
  version: 1.1.0
  description: >
    ## Filtering and sorting


    List endpoints that accept `filter` take one query parameter per condition,
    written `filter[field][comparator]=value`, for example
    `filter[name][contains]=North`. The comparators are `eq`, `neq`, `gt`,
    `geq`, `lt`, `leq` and `contains`, and `filter[field]=value` is short for
    `eq`. Conditions combine with AND. `contains` matches part of the value, is
    case-sensitive, and applies only to text fields. An unknown field or
    comparator, a value that doesn't fit the field's type, or a list or object
    as the value returns 400 with a message naming the problem. Each list
    operation names its filterable fields; some take only `eq`, and say so.


    `sort` takes a comma-separated list of fields, for example
    `sort=-created_at,name`. Each field sorts ascending, or descending with a
    `-` prefix. Unknown sort fields are ignored. Sorting by `id` orders by the
    record's internal ID, not its friendly ID. Each list operation names its
    sortable fields.
servers:
  - url: https://app.gomangrove.com/api/v1
security:
  - sec0: []
paths:
  /projects/{project_id}/data_requests:
    parameters:
      - $ref: '#/components/parameters/ProjectId'
    get:
      summary: List all data requests for a project
      description: >-
        Returns a paginated list of the project's data requests. Filterable
        fields: `friendly_id`, `name`, `role`, `sent_at`, `created_at`,
        `updated_at`. Requires the `read:project` and `read:data_request` token
        scopes.
      operationId: list-data-requests
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: sort
          in: query
          description: >-
            Sortable fields: `id`, `friendly_id`, `name`, `created_at`,
            `updated_at`, `sent_at`, `start_time`, `end_time`.
          schema:
            type: string
            example: '-created_at'
        - name: filter[role][eq]
          in: query
          schema:
            type: string
            enum:
              - sendable
              - template
        - name: filter[name][contains]
          in: query
          schema:
            type: string
        - name: filter[sent_at][geq]
          in: query
          schema:
            type: string
            format: date-time
        - name: filter[sent_at][leq]
          in: query
          schema:
            type: string
            format: date-time
        - name: filter[created_at][geq]
          in: query
          schema:
            type: string
            format: date-time
        - name: filter[created_at][leq]
          in: query
          schema:
            type: string
            format: date-time
        - name: fields
          in: query
          description: >-
            Comma-separated fields to return in each row. Other names are
            ignored. When any recognized name is given, `schedule` is left out
            of the rows. Ignored with `response_mode=summary`.
          schema:
            type: string
        - $ref: '#/components/parameters/SummaryResponseMode'
      responses:
        '200':
          description: >-
            Paginated list. With `response_mode=summary`, a count and up to 10
            samples instead.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/DataRequest'
                      info:
                        $ref: '#/components/schemas/PaginationInfo'
                    required:
                      - data
                      - info
                  - allOf:
                      - $ref: '#/components/schemas/SummaryResponse'
                      - properties:
                          samples:
                            items:
                              $ref: '#/components/schemas/DataRequest'
              example:
                data:
                  - id: req_AaBbCcDdEeFfGgHh
                    name: Monthly fuel use
                    role: sendable
                    start_time: '2026-03-01T00:00:00.000Z'
                    end_time: '2026-04-01T00:00:00.000Z'
                    sent_at: '2026-04-02T09:00:00.000Z'
                    message: Please upload last month's fuel records.
                    url: https://app.gomangrove.com/nexus/data_requests/SIGNED_ID
                    template_id: null
                    recurring_schedule_friendly_id: null
                    created_at: '2026-04-02T09:00:00.000Z'
                    updated_at: '2026-04-02T09:00:00.000Z'
                    schedule: null
                info:
                  items: 1
                  page_size: 20
                  total_items: 1
                  current_page: 1
                  next_page: null
                  previous_page: null
                  total_pages: 1
                  sort: []
                  filter: []
                  fields: null
        '400':
          description: An invalid page, filter, filter value or `response_mode`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: >-
                      Unsupported filter 'start_time'. Filterable fields: id,
                      friendly_id, name, role, sent_at, template_id, created_at,
                      updated_at.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/NoNexusConfig'
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: The project's friendly ID (e.g. `prj_aBcD1234eFgH5678`).
      schema:
        type: string
    Page:
      name: page
      in: query
      description: >-
        The page to return, starting at 1. A value below 1 or a non-numeric
        value returns 400.
      schema:
        type: integer
        format: int32
        default: 1
        minimum: 1
    PageSize:
      name: page_size
      in: query
      description: >-
        Rows per page, from 1 to 200. A value below 1 counts as 1 and a value
        above 200 as 200; a non-numeric value uses the default.
      schema:
        type: integer
        format: int32
        default: 20
        minimum: 1
        maximum: 200
    SummaryResponseMode:
      name: response_mode
      in: query
      description: >-
        `default` returns a page of rows. `summary` returns the number of
        matching records and up to 10 sample rows. This endpoint doesn't support
        `summary_with_export`, which returns 400.
      schema:
        type: string
        enum:
          - default
          - summary
  schemas:
    DataRequest:
      type: object
      properties:
        id:
          type: string
          example: req_AaBbCcDdEeFfGgHh
        name:
          type:
            - string
            - 'null'
        role:
          type: string
          enum:
            - sendable
            - template
          description: >-
            `template` for a request with a recurring schedule, which sends a
            copy on each run; otherwise `sendable`.
        start_time:
          type:
            - string
            - 'null'
          format: date-time
        end_time:
          type:
            - string
            - 'null'
          format: date-time
        sent_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the request email was first sent, or null.
        message:
          type:
            - string
            - 'null'
        url:
          type: string
          format: uri
          description: >-
            The submission link sent to recipients. Anyone holding it can submit
            data without signing in, so treat it as a secret.
          example: https://app.gomangrove.com/nexus/data_requests/SIGNED_ID
        template_id:
          type:
            - string
            - 'null'
          description: The friendly ID of the template this request was sent from, if any.
          example: req_AaBbCcDdEeFfGgHh
        recurring_schedule_friendly_id:
          type:
            - string
            - 'null'
          description: >-
            The friendly ID of the recurring schedule that sent this request, if
            any.
        schedule:
          description: The attached schedule, or null when there is none.
          anyOf:
            - $ref: '#/components/schemas/Schedule'
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationInfo:
      type: object
      description: >-
        Where this page sits in the full result, and the sort, filters and
        fields the request applied.
      properties:
        items:
          type: integer
          description: Rows on this page.
          example: 2
        page_size:
          type: integer
          description: Rows per page.
          example: 20
        total_items:
          type: integer
          description: Rows matching the request across all pages.
          example: 2
        current_page:
          type: integer
          description: This page's number, starting at 1.
          example: 1
        next_page:
          type:
            - integer
            - 'null'
          description: The next page's number, or null on the last page.
        previous_page:
          type:
            - integer
            - 'null'
          description: The previous page's number, or null on the first page.
        total_pages:
          type: integer
          description: Pages in the full result.
          example: 1
        sort:
          type: array
          description: >-
            The sort applied, one entry per field, in order. Present on list
            endpoints that accept `sort`.
          items:
            type: object
            properties:
              field:
                type: string
              direction:
                type: string
                enum:
                  - asc
                  - desc
        filter:
          type: array
          description: >-
            The filters applied, one entry per field and comparator. Present on
            list endpoints that accept `filter`.
          items:
            type: object
            properties:
              field:
                type: string
              comparator:
                type: string
                enum:
                  - eq
                  - neq
                  - gt
                  - geq
                  - lt
                  - leq
                  - contains
              value: {}
        fields:
          type:
            - array
            - 'null'
          description: >-
            The requested `fields`, or null when none were requested. Present on
            list endpoints that accept `fields`.
          items:
            type: string
    SummaryResponse:
      type: object
      description: Returned instead of a page when `response_mode=summary`.
      required:
        - count
        - samples
        - response_mode
      properties:
        count:
          type: integer
          description: Number of records matching the request's filters.
        samples:
          type: array
          maxItems: 10
          description: >-
            Up to 10 matching records, in the same shape as the page's `data`
            rows.
          items:
            type: object
        response_mode:
          type: string
          enum:
            - summary
    ErrorResponse:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
                description: Human-readable error message
              field:
                type: string
                description: Attribute the error applies to (validation errors only)
              code:
                type: string
                description: Machine-readable error code (validation errors only)
              blocking:
                type: array
                description: >-
                  Bounded preview of the records blocking a destroy
                  (blocked-destroy errors only)
                items:
                  $ref: '#/components/schemas/DeletionBlockingRecord'
              blocking_count:
                type: integer
                description: >-
                  Total count of records blocking a destroy (blocked-destroy
                  errors only)
              config_key:
                type: string
                description: >-
                  The data feed source config setting to fix, when the error is
                  on `config` (data feed source validation errors only)
              count:
                type: number
                description: >-
                  The limit or comparison value the failed validation checked
                  against, e.g. a maximum length or a numeric bound (validation
                  errors only, when the validation has one)
              value:
                description: >-
                  The rejected value, e.g. on an inclusion or uniqueness failure
                  (validation errors only, when the validation reports one)
    Schedule:
      type: object
      properties:
        id:
          type: string
          example: sch_AaBbCcDdEeFfGgHh
        status:
          type: string
          enum:
            - active
            - paused
            - completed
          description: '`completed` once the schedule has finished or been cancelled.'
        recurrence_rule:
          type:
            - object
            - 'null'
          description: Null for one-off schedules.
          properties:
            type:
              type: string
              enum:
                - daily
                - weekly
                - monthly
            interval:
              type: integer
              minimum: 1
        starts_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The first `next_execution_at` the schedule was created with.
        next_execution_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Null once the schedule is completed.
        last_executed_at:
          type:
            - string
            - 'null'
          format: date-time
        end_condition:
          type: string
          enum:
            - never
            - on_date
            - after_count
        end_date:
          type:
            - string
            - 'null'
          format: date
        max_occurrences:
          type:
            - integer
            - 'null'
        execution_count:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    DeletionBlockingRecord:
      type: object
      required:
        - type
      properties:
        type:
          type: string
        friendly_id:
          type: string
        name:
          type:
            - string
            - 'null'
          description: >-
            Display label, and the only identifier for records that have no
            friendly_id
  responses:
    Unauthorized:
      description: >-
        The API token is missing, invalid or expired. The body is empty, except
        for an expired token, which returns the error below.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: API token has expired
    Forbidden:
      description: >-
        The token lacks the scope the operation's description names, or a
        condition the description states applies, such as a feature that isn't
        enabled for your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: You are not authorized to perform this action
    NotFound:
      description: >-
        A resource named in the path doesn't exist in your account, or the token
        can't see it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: Record not found
    NoNexusConfig:
      description: >-
        The project has no nexus config yet. Create one with `POST
        /projects/{project_id}/nexus_config`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: Project does not have Nexus configuration
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: ''

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.