RallyUp's REST API version 1 provides two basic functionalities:

• Giving organizations easy access to their data in RallyUp to integrate with other data sources and data management software
• Giving partners the ability to integrate basic functionalities of RallyUp within their own software

Authentication

API calls require an authorization token to be passed as a Bearer token in the header. These tokens expire in 7 days, and can be generated via a call to the /v1/token endpoint with your organizational API credentials. Organizational API credentials are issued to organizations on a case-by-case basis. Contact RallyUp staff at support@rallyup.com with your organization's name and purpose for using the API to get started.

Response

Responses contain a Result object received from the API call.

Responses from the RallyUp API use the following status codes:

200 OK – Request was successful

204 No Content – There is no data to return on the request

400 Bad Request - The server could not understand the request due to invalid syntax

401 Unauthorized - Client not authenticated for requested response

403 Forbidden – Client does not have access rights to the content

404 Not Found - The server can not find the requested resource

405 Not Allowed - The request method is known by the server but has been disabled and cannot be used

500 Internal Server Error - The server has encountered a situation it doesn't know how to handle

503 Service Unavailable - The server is not ready to handle the request

Pagination

The /v1 endpoints below return paginated results. In this case, the results will contain a paginated object, containing the following information: Items, Count, PageIndex, PageSize, TotalCount, TotalPages, HasPreviousPage, HasNextPage.

Items is an array of objects returned with the API call.

Count is the number of results returned on the current page (i.e., the length of Items).

PageIndex is the page number of the current page.

PageSize is the maximum number of results per page.

TotalCount is the total number of results that match the request criteria (i.e., the sum of Count for all pages)

TotalPages is the total number of pages that contain results.

HasPreviousPage/HasNextPage are booleans that represents if there is a previous/next page.

The /v3 endpoints below will return an array of objects (the equivalent of the "Items" array from the /v1 endpoints).