AffiliateRail Resources API

The Resources API from AffiliateRail — 2 operation(s) for resources.

Operations 5

GET /v1/resources List resources #
POST /v1/resources Create a link resource #
GET /v1/resources/{id} Retrieve a resource #
POST /v1/resources/{id} Update a resource #
DELETE /v1/resources/{id} Delete a resource #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/affiliaterail-com:affiliaterail-com-resources-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

affiliaterail-com-resources-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Affiliaterail Com Resources API
  version: '2026-08-21'
  description: 'Operations tagged Resources across 2 of this provider''s published API definitions: affiliaterail-com-docs-openapi.json, affiliaterail-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.affiliaterail.com
  description: Production
tags:
- name: Resources
paths:
  /v1/resources:
    get:
      tags:
      - Resources
      summary: List resources
      description: 'Everything on the shelf, folders flattened onto each row. Empty `group_ids` and `tag_ids` mean every partner sees it.


        **Scope:** `read`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          example: prg_7uSyy9FqVLCFWrdPeZaK
          description: Required on every list
        required: true
        description: Required on every list
        name: program_id
        in: query
      - schema:
          type: string
          example: '25'
          description: 1 to 100, default 25
        required: false
        description: 1 to 100, default 25
        name: limit
        in: query
      - schema:
          type: string
          description: Object id; returns the page after it (older)
        required: false
        description: Object id; returns the page after it (older)
        name: starting_after
        in: query
      - schema:
          type: string
          description: Object id; returns the page before it (newer)
        required: false
        description: Object id; returns the page before it (newer)
        name: ending_before
        in: query
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: No relations on this resource
        required: false
        description: No relations on this resource
        name: expand[]
        in: query
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: Nothing to include on this resource
        required: false
        description: Nothing to include on this resource
        name: include[]
        in: query
      responses:
        '200':
          description: Resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV1Resources
      x-operation-id-source: derived
    post:
      tags:
      - Resources
      summary: Create a link resource
      description: 'A link on the shelf, published straight away unless you say otherwise. File uploads happen in the dashboard.


        **Scope:** `write`'
      security:
      - bearerAuth: []
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceCreate'
      responses:
        '201':
          description: The new resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: postV1Resources
      x-operation-id-source: derived
    servers:
    - url: https://api.affiliaterail.com
      description: Production
  /v1/resources/{id}:
    get:
      tags:
      - Resources
      summary: Retrieve a resource
      description: '**Scope:** `read`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          pattern: ^(sample_)?res_
          example: res_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`res_…`)
        required: true
        description: Prefixed id (`res_…`)
        name: id
        in: path
      responses:
        '200':
          description: The resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV1ResourcesById
      x-operation-id-source: derived
    post:
      tags:
      - Resources
      summary: Update a resource
      description: 'Title, folder, audience scoping and `published`; `url` on links only. Moving folders puts the resource at the end of the new one.


        **Scope:** `write`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          pattern: ^(sample_)?res_
          example: res_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`res_…`)
        required: true
        description: Prefixed id (`res_…`)
        name: id
        in: path
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceUpdate'
      responses:
        '200':
          description: The resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: postV1ResourcesById
      x-operation-id-source: derived
    delete:
      tags:
      - Resources
      summary: Delete a resource
      description: 'Files also lose their stored blob, best effort.


        **Scope:** `write`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          pattern: ^(sample_)?res_
          example: res_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`res_…`)
        required: true
        description: Prefixed id (`res_…`)
        name: id
        in: path
      responses:
        '200':
          description: Deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deleted'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: deleteV1ResourcesById
      x-operation-id-source: derived
    servers:
    - url: https://api.affiliaterail.com
      description: Production
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - authentication_error
              - permission_error
              - invalid_request_error
              - not_found_error
              - conflict_error
              - rate_limit_error
              - plan_error
              - not_implemented_error
              - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
          required:
          - type
          - code
          - message
      required:
      - error
    ResourceList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        has_more:
          type: boolean
          description: Pass the last object's id as `starting_after` to fetch the next page
        total_count:
          type: integer
          description: Count of every object matching the filters, ignoring the cursor
      required:
      - data
      - has_more
      - total_count
    Resource:
      type: object
      properties:
        id:
          type: string
          pattern: ^(sample_)?res_
          example: res_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`res_…`)
        object:
          type: string
          enum:
          - resource
        program_id:
          type: string
          pattern: ^(sample_)?prg_
          example: prg_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`prg_…`)
        kind:
          type: string
          enum:
          - file
          - link
        title:
          type: string
        url:
          type: string
        folder:
          type:
          - string
          - 'null'
        mime_type:
          type:
          - string
          - 'null'
        size_bytes:
          type:
          - integer
          - 'null'
        group_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?grp_
            example: grp_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`grp_…`)
          description: Empty means every group sees it
        tag_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?tag_
            example: tag_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`tag_…`)
        position:
          type: integer
        published:
          type: boolean
        published_at:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        metadata:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Your own key/value data, stored as given
        created_at:
          type: string
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        updated_at:
          type: string
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
      required:
      - id
      - object
      - program_id
      - kind
      - title
      - url
      - folder
      - mime_type
      - size_bytes
      - group_ids
      - tag_ids
      - position
      - published
      - published_at
      - metadata
      - created_at
      - updated_at
    ResourceUpdate:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 120
        url:
          type: string
          format: uri
          description: Links only; a file's URL is its blob
        folder:
          type:
          - string
          - 'null'
          maxLength: 60
        group_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?grp_
            example: grp_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`grp_…`)
        tag_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?tag_
            example: tag_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`tag_…`)
        published:
          type: boolean
    ResourceCreate:
      type: object
      properties:
        program_id:
          type: string
          pattern: ^(sample_)?prg_
          example: prg_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`prg_…`)
        title:
          type: string
          minLength: 1
          maxLength: 120
        url:
          type: string
          format: uri
          description: Where the link points. File uploads happen in the dashboard; the API manages links and existing files.
        folder:
          type:
          - string
          - 'null'
          maxLength: 60
        group_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?grp_
            example: grp_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`grp_…`)
          default: []
        tag_ids:
          type: array
          items:
            type: string
            pattern: ^(sample_)?tag_
            example: tag_7uSyy9FqVLCFWrdPeZaK
            description: Prefixed id (`tag_…`)
          default: []
        published:
          type: boolean
          default: true
      required:
      - program_id
      - title
      - url
    Deleted:
      type: object
      properties:
        id:
          type: string
          pattern: ^(sample_)?part_
          example: part_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`part_…`)
        object:
          type: string
        deleted:
          type: boolean
          enum:
          - true
      required:
      - id
      - object
      - deleted
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rail_live_… or rail_test_…
      description: Create keys in Settings → API keys. Each key carries scopes; the docs name the scope every route needs.
x-refined-from:
- affiliaterail-com-docs-openapi.json
- affiliaterail-com-openapi.json