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

# Collections status

> > **Requires scope** `organization:read` · `members:read` · `payments:read` · **Minimum role** viewer

Where the chapter stands with debt collections: agreement, settings, placement counts and dollars recovered. Debt collections (First Credit Services) is chapter-only and behind a feature flag; organizations without it get 404.

[Scopes and roles](https://docs.dueflow.co/api-reference/scopes)



## OpenAPI

````yaml /openapi.json get /v1/collections
openapi: 3.1.0
info:
  title: Dueflow API
  version: 1.0.0
  description: >-
    Read and write your organization's Dueflow data. Authenticate with a
    personal access token or an organization service token as a bearer
    credential; cookies are ignored. Every endpoint is also a tool on the
    Dueflow MCP server at https://api.dueflow.co/mcp, which accepts the same
    bearer tokens or an OAuth connection from ChatGPT and Claude.
  termsOfService: https://dueflow.co/terms
  contact:
    name: Dueflow support
    email: support@dueflow.co
    url: https://docs.dueflow.co
servers:
  - url: https://api.dueflow.co
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/collections:
    get:
      tags:
        - Collections
      summary: Collections status
      description: >-
        > **Requires scope** `organization:read` · `members:read` ·
        `payments:read` · **Minimum role** viewer


        Where the chapter stands with debt collections: agreement, settings,
        placement counts and dollars recovered. Debt collections (First Credit
        Services) is chapter-only and behind a feature flag; organizations
        without it get 404.


        [Scopes and roles](https://docs.dueflow.co/api-reference/scopes)
      operationId: getCollections
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type: string
                    enum:
                      - not_started
                      - agreement_requested
                      - 'on'
                      - stopped
                  eligibilityDays:
                    anyOf:
                      - type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      - type: 'null'
                  autoPlace:
                    type: boolean
                  agreement:
                    anyOf:
                      - type: object
                        properties:
                          signerName:
                            anyOf:
                              - type: string
                              - type: 'null'
                          version:
                            anyOf:
                              - type: string
                              - type: 'null'
                          signedAt:
                            anyOf:
                              - type: string
                                format: date-time
                              - type: 'null'
                        required:
                          - signerName
                          - version
                          - signedAt
                        additionalProperties: false
                      - type: 'null'
                  agreementRequest:
                    anyOf:
                      - type: object
                        properties:
                          signerName:
                            type: string
                          requestedAt:
                            type: string
                            format: date-time
                          sent:
                            type: boolean
                        required:
                          - signerName
                          - requestedAt
                          - sent
                        additionalProperties: false
                      - type: 'null'
                  placements:
                    type: object
                    properties:
                      open:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      closed:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      rejected:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - open
                      - closed
                      - rejected
                    additionalProperties: false
                  recovered:
                    type: object
                    properties:
                      gross:
                        description: Decimal dollars as a string, e.g. "125.00"
                        type: string
                      commission:
                        description: Decimal dollars as a string, e.g. "125.00"
                        type: string
                      net:
                        description: Decimal dollars as a string, e.g. "125.00"
                        type: string
                    required:
                      - gross
                      - commission
                      - net
                    additionalProperties: false
                required:
                  - state
                  - eligibilityDays
                  - autoPlace
                  - agreement
                  - agreementRequest
                  - placements
                  - recovered
                additionalProperties: false
        '401':
          description: Missing, malformed, expired or revoked token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks a required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource, or the token's organization can't see it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - organization:read
            - members:read
            - payments:read
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            param:
              type: string
            requiredScopes:
              type: array
              items:
                type: string
            requestId:
              type: string
            docsUrl:
              type: string
          required:
            - code
            - message
            - requestId
            - docsUrl
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Dueflow access token: `dfp_` (personal) or `dfs_` (service).
        Permissions are the token's scopes intersected with the role ceiling,
        re-evaluated per request.

````

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