🚀Getting started

tl;dr

• R0 is a personal relationship management tool with a REST API. This is a short get started to do list. Feel free to browse the pages below for more info 😎

• Download the Postman collection

• Create your API token

• Make your first API request

Welcome!

We're glad to have you here. R0 is a personal relationship management platform to help you organize your contact data. An active subscription or trial is required to get access to the R0 API. You can learn more about the company on our website. The R0 platform includes a REST API for accessing and modifying data stored within R0.

Did you know: R0 also has a Postman collection that includes all of our API endpoints. You can download the collection here.

Schema

• The R0 API is a RESTful API.

• All API access is over HTTPS.

• All ids are UUIDs.

• Most DELETE endpoints will "soft-delete" data. Read more.

Dates & times

All dates in R0 are stored in ISO8601 format in GMT time. All times sent to R0 are assumed to be in GMT unless otherwise specified. For example a user with the ET (-05:00) timezone set includes these date times in their request:

• 2023‐08‐03T09:16:59

  • Will result in the time being stored at 2023‐08‐03T09:16:59

• 2023‐08‐03T09:16:59−05:00

  • Will result in the time being stored at 2023‐08‐03T04:16:59Z

• 2023‐08‐03T09:16:59Z

  • Z signifies Zulu or GMT so the time will be stored as is.

Pagination

All endpoints that return a list of results will include some additional information in the response body. The count will provide you with a total record count across all pages, the default limit is 20 records for most objects. First will provide you with the first record on any given page. For example, if there are 20 records per page, then first will be 21 on page 2.

You can access additional pages via the ?page= query parameter:

{
    "count": 0,
    "first": 1,
    "has_next": false,
    "has_prev": false,
    "last": 0,
    "list": [],
    "next_page": 2,
    "page": 1,
    "prev_page": 0
}

Limit

You can adjust the number of results returned per page for several endpoints. Refer to the optional query parameters for each resource to see where this is applicable. Use the ?limit= query parameter to set this limit. By default, most lists return 20 records. However, requests for timezones and relationships always return full lists, both exceeding 20 records. The allowable range for the limit parameter for all applicable endpoints is 1 to 100 records; entering a number above 100 will default the limit to 100.

Authentication

All endpoints require authentication, your requests are authenticated via a bearer token. You can generate tokens within the R0 app website or via the /login API endpoint.