---
title: "Overview"
slug: "overview"
updated: 2025-08-26T17:47:35Z
published: 2025-08-26T18:38:53Z
canonical: "guide.youraspire.com/overview"
---

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

# Overview

### API guide

Reference this guide to understand how to use the API. It provides in-depth documentation and access to the API reference so you can execute requests to meet your company's unique needs.

Below is an outline of each guide section.   
[**API Foundations**](/v1-api/apidocs/restful-api-foundations)**:** Gain or refresh your foundational knowledge of RESTful APIs.

[**Quick Start**](https://guide.youraspire.com/apidocs/quick-start-1)**:** Collect the necessary information to access and generate requests using endpoints in the API reference.

[**Authentication & Authorization**](https://guide.youraspire.com/apidocs/authentication-and-authorization)**:** View step-by-step authentication and authorization instructions to access the API. 

[**Create a Request**](https://guide.youraspire.com/apidocs/create-a-request)**:** Learn how to make calls using the interactive console in the API guide or the Swagger UI.

[**OData Syntax and Query Parameters**](/v1-api/apidocs/odata-options-and-query-parameters)**:** Better understand the application of OData syntax when constructing queries so you can execute successful requests.

[**Status Codes**](https://guide.youraspire.com/apidocs/status-codes-2)**:** A comprehensive list defining the HTTP status codes encountered after request submission.

[](/v1-api/apidocs/throttling)[**Throttling**](/v1-api/apidocs/throttling)**:** A list of endpoints with throttling limitations.

[](https://guide.youraspire.com/apidocs/faqs)[**FAQs**](/v1-api/apidocs/faqs): Frequently asked questions. [](https://guide.youraspire.com/apidocs/glossary-1)[](https://guide.youraspire.com/apidocs/glossary-1) [](https://guide.youraspire.com/apidocs/glossary-1)

[**Glossary**](https://guide.youraspire.com/apidocs/glossary-1)**:** Terminology specific to the API.

[**What's New?**](/v1-api/apidocs/recent-updates)**:** View the release notes.

[**API Reference**](https://guide.youraspire.com/apidocs/api-reference): Rendering of the API definition. Includes the same publicly available endpoints accessed using the [Swagger UI](https://cloud-api.youraspire.com/swagger/index.html) tool. The reference is categorized by API resources and uncategorized by endpoints. After generating an access token using the steps outlined in the [Authentication & Authorization](https://guide.youraspire.com/apidocs/authentication-and-authorization) section, you can use the reference to construct and test calls the same way you would using the Swagger UI.

## Aspire External API essentials

The external Aspire API contains the following criteria:

- RESTful architectural design using [OData version 4](https://www.odata.org/documentation/).
  - Responses in JSON  data format.
- Securely transmits data via HTTPS .
- Uses the following HTTP methods:
  - **GET** - retrieve information.
  - **POST** - create or add new information.
  - **PUT** - update existing records.
  - **DELETE** - remove a record. This method does not currently apply to any External Aspire API reference resources.
  - **GET**, **PUT**, and **DELETE** are idempotent
- Bearer Authentication  security.
- Offers endpoint-level access for users.
- The API reference is also available via the [Swagger UI](https://cloud-api.youraspire.com/swagger/index.html). This guide only provides information about the RESTful API.

**Javascript Object Notation** - markup language used to store and exchange information between computers.

**Hypertext Transfer Protocol Secure** - transmits encrypted data over the internet using SSL/TLS.

Guarantees that responses for identically generated requests that have been called multiple times always remain the same. The main purposes of idempotency are to maintain consistency and mitigate unintended results.

Token-based authentication that can be used independently or with OAuth 2.0.