# OAuth Applications
> An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth [here](https://increase.com/documentation/oauth).

## The OAuth Application object
### Example
```json
{
  "client_id": "client_id_ec79nb1bukwwafdewe88",
  "created_at": "2020-01-31T23:59:59Z",
  "deleted_at": null,
  "id": "application_gj9ufmpgh5i56k4vyriy",
  "name": "Ian Crease's App",
  "status": "active",
  "type": "oauth_application"
}
```
### Attributes
- `client_id` (string)
  The OAuth Application's client_id. Use this to authenticate with the OAuth Application.

- `created_at` (string)
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Application was created.

- `deleted_at` (string, nullable)
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Application was deleted.

- `id` (string)
  The OAuth Application's identifier.

- `name` (string, nullable)
  The name you chose for this OAuth Application.

- `status` (enum)
  Whether the application is active.
  Cases:
  * `active` (The application is active and can be used by your users.)
  * `deleted` (The application is deleted.)

- `type` (string)
  A constant representing the object's type. For this resource it will always be `oauth_application`.

## List OAuth Applications
GET /oauth_applications

### Example
```curl
curl \
  --url "${INCREASE_URL}/oauth_applications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

- `status.in` (array of enums, optional)
  Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
  Cases:
  * `active` (The application is active and can be used by your users.)
  * `deleted` (The application is deleted.)

- `created_at.after` (string, optional)
  Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.before` (string, optional)
  Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_after` (string, optional)
  Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_before` (string, optional)
  Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

### Returns a OAuth Application List object:
```json
{
  "data": [
    {
      "client_id": "client_id_ec79nb1bukwwafdewe88",
      "created_at": "2020-01-31T23:59:59Z",
      "deleted_at": null,
      "id": "application_gj9ufmpgh5i56k4vyriy",
      "name": "Ian Crease's App",
      "status": "active",
      "type": "oauth_application"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Retrieve an OAuth Application
GET /oauth_applications/{oauth_application_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/oauth_applications/application_gj9ufmpgh5i56k4vyriy" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `oauth_application_id` (string, required)
  The identifier of the OAuth Application.