Help Search

Edit on github

Favorites

The Favorite endpoints are used to add or remove a Resource from your favorites.

The Favorite object

Attribute Type Description Format
id String Unique ID of the favorite object in UUID format. UUID
created String Datetime when the resource was created ISO 8601 Datetime format
2014-02-01T09:28:56.321-10:00
foreign_key String UUID of the Resource to add UUID
foreign_model String The Object the favorites is associated with. This can only be "Resource" at the moment. String
modified String Datetime when the resource was last modified ISO 8601 Datetime format
2014-02-01T09:28:56.321-10:00

Examples

{
    "user_id": "f848277c-5398-58f8-a82a-72397af2d450",
    "foreign_key": "4d7adb92-0d85-56d7-8b92-e2b919ef8eb8",
    "foreign_model": "Resource",
    "created": "2019-04-12T07:58:36+00:00",
    "modified": "2019-04-12T07:58:36+00:00",
    "id": "288050d2-25b0-4c04-a959-2fc6f4011208"
}

Last updated

This article was last updated on April 23rd, 2019.

For another perspective on the API you browse the OpenAPI 2.0 specifications using the dedicated API reference site (Swagger UI).

API Reference

You can also find the latest OpenAPI 2.0 specifications directly on the dedicated repository.

OpenAPI Specs repository