Loading ...

REST API: Get Follow ID | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Follow ID
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 24

REST API: Get Follow ID

0 
 /5
0 (0votes)
Open API Guide
GET/api/follow/getid

Check whether the authenticated user is following a specific piece of content. Returns the follow ID when the user follows it, and answers 404 with no body when they do not. Use this to toggle follow/unfollow states in your UI.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
EntityIDIntegerYESQueryUnique ID of the content
EntityTypeStringYESQueryID of the entity type. See REST API: System Entity Types . A number that is not an entity type answers 404, the same as for content the caller does not follow. A word that is not an entity type name answers 400.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/follow/getid?EntityType=3&EntityID=7995

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": 2491
}

Error Response

{
  "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/follow/getid?EntityType=3'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEntityID is not an integer, or EntityType is not a number or an entity type name.Check the request against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: this endpoint has no permission check and looks up only the follows of the calling user.No permission change is needed.
404 Not FoundThe current user does not follow the content; the response has no body.Treat 404 as not following.
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