OpenAPI Specification
openapi: 3.0.3
info:
title: Rightsline Availability Contacts API
description: The Rightsline API is organized around a REST architecture with predictable, resource-oriented URLs and HTTP response codes to indicate errors. It enables real-time integrations for rights management, royalty calculations, availability checking, and workflow automation for media and entertainment companies. Supports bulk operations of up to 100 records per request.
version: v4
contact:
name: Rightsline API Documentation
url: https://api-docs.rightsline.com/
termsOfService: https://www.rightsline.com/terms-of-service/
servers:
- url: https://app.rightsline.com/v4
description: US Production
- url: https://app.rightsline.eu/v4
description: EU Production
tags:
- name: Contacts
description: Contact and company management
paths:
/contacts:
get:
operationId: listContacts
summary: List Contacts
description: Returns a list of contact records for master data management.
tags:
- Contacts
parameters:
- name: limit
in: query
schema:
type: integer
default: 25
- name: offset
in: query
schema:
type: integer
default: 0
security:
- ApiKey: []
responses:
'200':
description: Contact records
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Contact'
pagination:
$ref: '#/components/schemas/Pagination'
post:
operationId: createContact
summary: Create Contact
description: Creates a new contact record.
tags:
- Contacts
security:
- ApiKey: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ContactCreate'
responses:
'201':
description: Contact created
content:
application/json:
schema:
$ref: '#/components/schemas/Contact'
components:
schemas:
Pagination:
type: object
properties:
total:
type: integer
limit:
type: integer
offset:
type: integer
Contact:
type: object
description: A contact or company record
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- Individual
- Company
email:
type: string
format: email
phone:
type: string
createdAt:
type: string
format: date-time
ContactCreate:
type: object
required:
- name
- type
properties:
name:
type: string
type:
type: string
email:
type: string
phone:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: Authorization
description: Bearer token obtained by exchanging Company API Key + Access Key + Secret Access Key. Generate credentials in app.rightsline.com Profile > API Access.