Backoffice API
  1. References
Backoffice API
  • Back to home
  • Core
  • Assets
    • Images
      • Create Asset Image
      • Asset Image by id
      • Asset Image by key
      • Asset Image by hash
      • Delete Asset Image by id
      • Restore soft deleted Asset image by id
  • Categories
    • Paginated Categories
      GET
    • Create Category
      POST
    • Category by id
      GET
    • Update Category by id
      PATCH
    • Delete Category by id
      DELETE
    • Restore soft deleted Category by id
      POST
  • References
    • Create Reference
      POST
    • Reference by ref
      GET
    • Remove Reference by ref
      DELETE
    • Lookup References
      POST
  1. References

Reference by ref

GET
/references/{ref}

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
API Key
Add parameter in query
x-api-key
Example:
x-api-key: ********************
or
Path Params

Responses

🟢200Success
application/json
Body

🟠401Unauthorized API KEY
🟠403Unauthorized roles
🟠404Entity not found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://prod.your-api-server.com/api/core/v2/references/facebook:07d56a6e-4bce-4e7d-b539-1e68c6d48d90' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "provider": "facebook",
        "urn": "urn:docs:content:54bb6cb4-b060-4a75-b1c1-823fd97467aa",
        "expires_at": "2019-08-24T14:15:22.123Z"
    }
}
Modified at 2025-06-19 16:41:25
Previous
Create Reference
Next
Remove Reference by ref
Built with