Public API Documentation > Resources > Applications

This API endpoint requires a valid user access token.

Applications API

An application provides a client ID and secret to interact with the Artsy API. See Authentication for more information.

Retrieving Applications

Users can retrieve their own applications by following the applications link from root.

curl -v "https://stagingapi.artsy.net/api/applications?user_id=USER_ID" -H "X-Access-Token: ACCESS_TOKEN"

This endpoint accepts the following parameters.

Name Value
user_id Application owner (user) ID.

The response is a paginated result with embedded applications.

{
  "total_count" : 1,
  "_links" : {
    "self" : {
      "href" : "https://stagingapi.artsy.net/api/applications?user_id=..."
    },
    "next" : {
      "href" : "https://stagingapi.artsy.net/api/applications?cursor=...&user_id=..."
    }
  },
  "_embedded" : {
    "applications" : [
      {
        "id":"...",
        ...
      }
    ]
  }
}

A request without a "user_id" will be redirected accordingly with a 302 HTTP status code.

Retrieving an Application

Users can retrieve a specific application by ID by rendering the "application" link template from root.

curl -v "https://stagingapi.artsy.net/api/applications/{id}" -H "X-Access-Token: ACCESS_TOKEN"

Users are only authorized to retrieve their own applications.

Application JSON Format

error: the server responded with status 404

Links

Key Target
self The application resource.
user User that owns the application.

Example

{
  "id" : "...",
  "created_at" : "2014-08-31T15:05:29+00:00",
  "updated_at" : "2014-08-31T15:05:29+00:00",
  "name" : "Test",
  "client_id" : "...",
  "client_secret" : "...",
  "enabled" : true,
  "_links" : {
    "self" : {
      "href" : "https://stagingapi.artsy.net/api/applications/..."},
    "user" : {
      "href" : "https://stagingapi.artsy.net/api/users/4dc805b18101da0001000489"
    }
  }
}