Resources

Retrieve a resource

Scope: read

get/v1/resources/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/resources/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (res_…)

Example:res_7uSyy9FqVLCFWrdPeZaK

Response

The resource

idstring required

Prefixed id (res_…)

object'resource' required
program_idstring required

Prefixed id (prg_…)

kind'file' | 'link' required
titlestring required
urlstring required
folderstring nullable required
mime_typestring nullable required
size_bytesinteger nullable required
group_idsstring[] required

Empty means every group sees it

tag_idsstring[] required
positioninteger required
publishedboolean required
published_atstring date-time nullable required

ISO-8601, UTC

metadataobject nullable required

Your own key/value data, stored as given

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "res_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "group_ids": [
    "grp_7uSyy9FqVLCFWrdPeZaK"
  ],
  "tag_ids": [
    "tag_7uSyy9FqVLCFWrdPeZaK"
  ],
  "published_at": "2026-08-21T10:15:30.000Z",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.