Records Management

Fetch a single record with optional child records

Retrieves a specific record by its ID. Optionally, fetches related child records for the specified parent record.

get/api/{objectName}/{recordId}/{childObjectName}

Request

  • Base URL: https://api.reallysimplesystems.com
  • URL: https://api.reallysimplesystems.com/api/{objectName}/{recordId}/{childObjectName}
  • Auth: HTTP bearer

Query parameters

limitinteger

The number of child records per page. Defaults to 20.

Example:20
pageinteger

The page number to retrieve child records. Defaults to the first page.

Example:1
orderobject

A JSON object specifying the fields to order child records by and their direction (asc or desc). Each key is a field name, and the value is the sort direction. Example: {"name": "asc", "created_at": "desc"}. Field names are case-insensitive.

qobject

A JSON object specifying filters for child records. Example: ?q={“name”: “Test”} or ?q={“name”: “Test”, “sector”: “Design”}.

Response

Successful response containing the parent record or a paginated list of child records.

Example response

{
  "data": {
    "metadata": {
      "url": "http://api.example.com/api/account/1",
      "list_url": "http://api.example.com/api/accounts",
      "parent": null,
      "object_type": "record",
      "record_type": "account"
    },
    "record": {
      "id": 1,
      "name": "Example Account",
      "created_at": "2024-11-08T00:00:00.000000Z",
      "updated_at": "2024-11-08T00:00:00.000000Z"
    },
    "children": {
      "contacts": {
        "object_type": "list",
        "record_type": "contact",
        "url": "/accounts/1/contacts",
        "total_count": 5
      },
      "activities": {
        "object_type": "list",
        "record_type": "activity",
        "url": "/accounts/1/activities",
        "total_count": 3
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.