Loading ...

REST API: Get Single Bookmark for a User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Bookmarks » REST API: Get Single Bookmark for a User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 36

REST API: Get Single Bookmark for a User

0 
 /5
0 (0votes)
Open API Guide
GET/api/content/{ContentID}/bookmarks

Get one user's bookmark of a content item.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
ContentIDIntegerYESPathUnique identifier for a particular content. 
UserIDIntegerYESQueryUser whose bookmark is returned. It is used when it is the caller's own ID, or for any user when the caller is a site administrator. Otherwise, or when it is left out or is not a whole number, the list of everyone's bookmarks is returned instead (see Get List of Users Who Bookmarked a Piece of Content). That list is for site administrators only, so a site administrator who leaves UserID out gets 200 with the list, and any other caller gets 403.
EntityTypeIntegerYESQueryEntity type number of the content: Article = 3, Blog = 4, Calendar events = 5, Photo = 6, Video = 7, Wiki = 9, File = 14, Album = 18, Case = 19, Idea = 44. A number that does not match the content's type finds no bookmark, and the call answers Content not found.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/7996/bookmarks?EntityType=3&UserID=376

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "BookmarkID": 193,
    "EntityID": 12126,
    "EntityType": 3,
    "ContentTypeID": 0,
    "SpaceID": 0,
    "Url": "",
    "UserID": 21,
    "DateCreated": "2026-09-27T02:22:19.117",
    "SortOrder": 0,
    "Title": "Jupiter Facts",
    "Description": "Facts about the largest planet.",
    "BookmarkEntityIconCssClass": "icon-file",
    "PageID": 0,
    "TenantID": 0
  }
}

Error Response

{
  "Message": "The requested resource does not support http method 'GET'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestContentID in the path or EntityType is not an integer.Send numeric values.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUserID names another user, is left out, or is not a whole number, and the caller is not a site administrator. The call then falls back to the full list, which is for site administrators only. The response has no body.Send your own UserID, or use a site administrator's token.
200 with ResponseData nullThe user has no bookmark of the content: ResponseData is absent and ResponseMessage reads Content not found.Treat it as not bookmarked.
500 Server ErrorInternal failure.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none. The message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter. The message does not mean the item you asked for is missing.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages