---
updatedAt: 2026-05-28T09:04:28.000Z
agentTools:
  projectIndex: https://developer.oneflow.com/llms.txt
---

# Get a reminder by ID

Use this endpoint to get a reminder on the contract.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python"
    ]
  },
  "info": {
    "description": "This section describes all Oneflow public APIs and their methods used for creating and interacting with Oneflow contracts. All references are grouped into several main categories according to their function:",
    "version": "1",
    "title": "Public API for Oneflow"
  },
  "servers": [
    {
      "url": "https://{hostname}/v1",
      "variables": {
        "hostname": {
          "default": "api.oneflow.com"
        }
      }
    }
  ],
  "paths": {
    "/contracts/{contract_id}/reminders/{reminder_id}": {
      "get": {
        "summary": "Get a reminder by ID",
        "operationId": "get-a-reminder-by-id",
        "description": "Use this endpoint to get a reminder on the contract.",
        "parameters": [
          {
            "name": "x-oneflow-api-token",
            "description": "The API key of your Oneflow account.",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "^[a-zA-Z0-9-]+$",
              "minLength": 40,
              "maxLength": 40
            },
            "example": "9841f1ee533681c3ea6a438560f2bb6c73b76675"
          },
          {
            "name": "x-oneflow-user-email",
            "description": "The email address of a registered Oneflow user.",
            "required": true,
            "in": "header",
            "schema": {
              "type": "string",
              "format": "email",
              "example": "john.doe@oneflow.com"
            },
            "x-oneflow-replace": {
              "schema": {
                "type": "string",
                "format": "email",
                "example": "john.doe@oneflow.com"
              }
            }
          },
          {
            "name": "contract_id",
            "in": "path",
            "required": true,
            "description": "The unique ID of the contract.",
            "schema": {
              "type": "integer",
              "format": "signed_integer_id"
            },
            "example": 10001
          },
          {
            "name": "reminder_id",
            "in": "path",
            "required": true,
            "description": "The unique ID of the contract reminder.",
            "schema": {
              "type": "integer",
              "format": "signed_integer_id"
            },
            "example": 400001
          }
        ],
        "responses": {
          "200": {
            "description": "Return a reminder.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Contract reminder.",
                  "required": [
                    "contract_id",
                    "date_time",
                    "id",
                    "message",
                    "subject",
                    "users"
                  ],
                  "properties": {
                    "contract_id": {
                      "description": "The id of the contract.",
                      "type": "integer",
                      "format": "signed_integer_id"
                    },
                    "date_time": {
                      "description": "The date and time the reminder should send.",
                      "type": "string",
                      "format": "datetime"
                    },
                    "id": {
                      "description": "The id of the reminder.",
                      "type": "integer",
                      "format": "signed_integer_id"
                    },
                    "message": {
                      "description": "The message of the reminder.",
                      "type": "string",
                      "minLength": 1
                    },
                    "subject": {
                      "description": "The subject of the reminder.",
                      "type": "string",
                      "minLength": 1
                    },
                    "users": {
                      "description": "An object containing users of a reminder.",
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "created_by",
                        "recipients"
                      ],
                      "properties": {
                        "created_by": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "email",
                            "id",
                            "name"
                          ],
                          "properties": {
                            "email": {
                              "type": "string",
                              "format": "email"
                            },
                            "id": {
                              "type": "integer",
                              "format": "signed_integer_id"
                            },
                            "name": {
                              "type": "string",
                              "minLength": 1
                            }
                          }
                        },
                        "recipients": {
                          "description": "The list of recipients for a particular reminder.",
                          "type": "array",
                          "items": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "email",
                              "id",
                              "name"
                            ],
                            "properties": {
                              "email": {
                                "type": "string",
                                "format": "email"
                              },
                              "id": {
                                "type": "integer",
                                "format": "signed_integer_id"
                              },
                              "name": {
                                "type": "string",
                                "minLength": 1
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "contractReminderResponseExample": {
                    "value": {
                      "contract_id": 10001,
                      "date_time": "2023-05-10T06:30:00+00:00",
                      "id": 400001,
                      "message": "sample reminder message",
                      "subject": "sample reminder subject",
                      "users": {
                        "created_by": {
                          "email": "oliver.queen@qc.com",
                          "id": 190001,
                          "name": "Oliver Queen"
                        },
                        "recipients": [
                          {
                            "email": "oliver.queen@qc.com",
                            "id": 190001,
                            "name": "Oliver Queen"
                          },
                          {
                            "email": "john.diggel@qc.com",
                            "id": 190002,
                            "name": "John Diggle"
                          },
                          {
                            "email": "wally.west@qc.com",
                            "id": 190003,
                            "name": "Wally West"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "The API token or the user email is invalid."
          },
          "404": {
            "description": "A required entity is missing."
          }
        },
        "tags": [
          "Contract - Reminders"
        ]
      }
    }
  }
}
```