# API Documentation

## API v4

- [Introduction](https://api-docs.rightsline.com/master.md)
- [Overview](https://api-docs.rightsline.com/overview.md)
- [API request limits](https://api-docs.rightsline.com/overview/request-limits.md): Limits on the number of API requests for a given time period.
- [Errors](https://api-docs.rightsline.com/overview/errors.md): Possible error responses that you may receive from the API.
- [Other references](https://api-docs.rightsline.com/overview/other-references.md): Additional resources to help integrate with Rightsline.
- [Getting started](https://api-docs.rightsline.com/getting-started.md): Get started sending requests to the Rightsline API.
- [What's new in v4?](https://api-docs.rightsline.com/getting-started/whats-new-in-v4.md): The new features and endpoints available as part of v4 of the Rightsline API.
- [Transitioning from v3 to v4](https://api-docs.rightsline.com/getting-started/transitioning-from-v3-to-v4.md): Change notes for transitioning to using v4 of the Rightsline API.
- [Requesting temporary credentials](https://api-docs.rightsline.com/authentication/requesting-temporary-credentials.md): Request temporary credentials to be used to authenticate API requests.
- [Signing requests](https://api-docs.rightsline.com/authentication/signing-requests.md): Calculate the Authorization signature for API requests.
- [User permissions](https://api-docs.rightsline.com/authentication/user-permissions.md)
- [Char types](https://api-docs.rightsline.com/entities/char-types.md): Each char type in Rightsline relates to a single numeric identifier, often referred to as a Char Type ID.  These char type identifiers are used when describing relationships between entities.
- [The entity object](https://api-docs.rightsline.com/entities/the-entity-object.md): All Rightsline entities share a common structure.  This structure is used to enforce consistency across different entity types.
- [Amount](https://api-docs.rightsline.com/entities/amount.md)
- [Create an amount](https://api-docs.rightsline.com/entities/amount/amount-create.md)
- [Retrieve an amount](https://api-docs.rightsline.com/entities/amount/amount-retrieve.md)
- [Update an amount](https://api-docs.rightsline.com/entities/amount/amount-update.md)
- [Delete an amount](https://api-docs.rightsline.com/entities/amount/amount-delete.md)
- [Retrieve amount statuses](https://api-docs.rightsline.com/entities/amount/retrieve-amount-statuses.md)
- [Retrieve amount workflow processes](https://api-docs.rightsline.com/entities/amount/retrieve-amount-processes.md)
- [Retrieve amount draft templates](https://api-docs.rightsline.com/entities/amount/retrieve-amount-draft-templates.md)
- [Retrieve amount audit history](https://api-docs.rightsline.com/entities/amount/audit-history.md): Retrieve the audit history for an amount record.
- [Switch amount template](https://api-docs.rightsline.com/entities/amount/switch-amount-template.md): Switches the amount record to a new template
- [Retrieve amount validation errors](https://api-docs.rightsline.com/entities/amount/validation-errors.md)
- [Catalog item](https://api-docs.rightsline.com/entities/catalog-item.md)
- [Create a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-create.md)
- [Retrieve a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-retrieve.md)
- [Update a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-update.md)
- [Delete a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-delete.md)
- [Retrieve catalog item template list](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-template-list.md)
- [Retrieve catalog item statuses](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-statuses.md)
- [Retrieve catalog item workflow processes](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-processes.md)
- [Retrieve catalog item draft templates](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-draft-templates.md)
- [Retrieve catalog item key art URL](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-key-art-url.md): Used to retrieve key art for a catalog item.
- [Upload/update catalog item key art](https://api-docs.rightsline.com/entities/catalog-item/update-catalog-item-key-art.md): Upload/update the key art for a catalog item.
- [Delete catalog item key art](https://api-docs.rightsline.com/entities/catalog-item/delete-catalog-item-key-art.md): Delete the key art for a catalog item.
- [Retrieve catalog item audit history](https://api-docs.rightsline.com/entities/catalog-item/audit-history.md): Retrieve the audit history for a catalog item record.
- [Switch catalog item template](https://api-docs.rightsline.com/entities/catalog-item/switch-catalog-item-template.md): Switches the catalog item record to a new template
- [Retrieve catalog item validation errors](https://api-docs.rightsline.com/entities/catalog-item/validation-errors.md)
- [Retrieve all rights in catalog hierarchy](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-rights-in-hierarchy.md)
- [Catalog item delete check](https://api-docs.rightsline.com/entities/catalog-item/delete-check.md)
- [Retrieve catalog item worksheets](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-worksheets.md)
- [Overwrite catalog item parties](https://api-docs.rightsline.com/entities/catalog-item/overwrite-catalog-item-parties.md)
- [Contact](https://api-docs.rightsline.com/entities/contact.md)
- [Create a contact](https://api-docs.rightsline.com/entities/contact/contact-create.md)
- [Retrieve a contact](https://api-docs.rightsline.com/entities/contact/contact-retrieve.md)
- [Update a contact](https://api-docs.rightsline.com/entities/contact/contact-update.md)
- [Delete a contact](https://api-docs.rightsline.com/entities/contact/contact-delete.md)
- [Retrieve contact statuses](https://api-docs.rightsline.com/entities/contact/retrieve-contact-statuses.md)
- [Retrieve contact workflow processes](https://api-docs.rightsline.com/entities/contact/retrieve-contact-processes.md)
- [Retrieve contact draft templates](https://api-docs.rightsline.com/entities/contact/retrieve-contact-draft-templates.md)
- [Retrieve contact audit history](https://api-docs.rightsline.com/entities/contact/audit-history.md): Retrieve the audit history for a contact record.
- [Switch contact template](https://api-docs.rightsline.com/entities/contact/switch-contact-template.md): Switches the contact record to a new template
- [Contact delete check](https://api-docs.rightsline.com/entities/contact/delete-check.md)
- [Retrieve contact validation errors](https://api-docs.rightsline.com/entities/contact/validation-errors.md)
- [Deal](https://api-docs.rightsline.com/entities/deal.md)
- [Create a deal](https://api-docs.rightsline.com/entities/deal/deal-create.md)
- [Retrieve a deal](https://api-docs.rightsline.com/entities/deal/deal-retrieve.md)
- [Update a deal](https://api-docs.rightsline.com/entities/deal/deal-update.md)
- [Delete a deal](https://api-docs.rightsline.com/entities/deal/deal-delete.md)
- [Retrieve deal statuses](https://api-docs.rightsline.com/entities/deal/retrieve-deal-statuses.md)
- [Retrieve deal workflow processes](https://api-docs.rightsline.com/entities/deal/retrieve-deal-processes.md)
- [Retrieve deal draft templates](https://api-docs.rightsline.com/entities/deal/retrieve-deal-draft-templates.md)
- [Retrieve deal audit history](https://api-docs.rightsline.com/entities/deal/audit-history.md): Retrieve the audit history for a deal record.
- [Switch deal template](https://api-docs.rightsline.com/entities/deal/switch-deal-template.md): Switches the deal record to a new template
- [Retrieve deal validation errors](https://api-docs.rightsline.com/entities/deal/validation-errors.md)
- [Retrieve deal conflicts](https://api-docs.rightsline.com/entities/deal/conflicts.md)
- [Override deal conflict](https://api-docs.rightsline.com/entities/deal/override-conflict.md)
- [Overwrite deal parties](https://api-docs.rightsline.com/entities/deal/overwrite-deal-parties.md)
- [File](https://api-docs.rightsline.com/entities/file.md)
- [Create a file](https://api-docs.rightsline.com/entities/file/file-create.md)
- [Retrieve a file](https://api-docs.rightsline.com/entities/file/file-retrieve.md)
- [Retrieve File Version](https://api-docs.rightsline.com/entities/file/file-version-retrieve.md)
- [Retrieve File Revisions](https://api-docs.rightsline.com/entities/file/file-revisions-retrieve.md): Retrieve a list of the existing revisions of a specific file.
- [Retrieve file data](https://api-docs.rightsline.com/entities/file/file-data-retrieve.md)
- [Retrieve File Version URL](https://api-docs.rightsline.com/entities/file/file-version-url-retrieve.md)
- [Retrieve File Version Data](https://api-docs.rightsline.com/entities/file/file-version-data-retrieve.md)
- [Delete a file](https://api-docs.rightsline.com/entities/file/file-delete.md)
- [Retrieve file statuses](https://api-docs.rightsline.com/entities/file/retrieve-file-statuses.md)
- [Retrieve file workflow processes](https://api-docs.rightsline.com/entities/file/retrieve-file-processes.md)
- [Retrieve file draft templates](https://api-docs.rightsline.com/entities/file/retrieve-file-draft-templates.md)
- [Retrieve file validation errors](https://api-docs.rightsline.com/entities/file/validation-errors.md)
- [Grant Access To File](https://api-docs.rightsline.com/entities/file/grant-access-to.md): This will grant a user or users access to the file in Partner Portal.
- [Revoke Access From File](https://api-docs.rightsline.com/entities/file/revoke-access-from.md): This will revoke a user or users access to the file in Partner Portal.
- [Financial document](https://api-docs.rightsline.com/entities/financial-document.md)
- [Create a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-create.md)
- [Retrieve a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-retrieve.md)
- [Update a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-update.md)
- [Delete a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-delete.md)
- [Retrieve financial document statuses](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-statuses.md)
- [Retrieve financial document workflow processes](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-processes.md)
- [Retrieve financial document draft templates](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-draft-templates.md)
- [Retrieve financial document audit history](https://api-docs.rightsline.com/entities/financial-document/audit-history.md): Retrieve the audit history for a financial document record.
- [Switch financial document template](https://api-docs.rightsline.com/entities/financial-document/switch-financial-document-template.md): Switches the financial document record to a new template
- [Retrieve financial document validation errors](https://api-docs.rightsline.com/entities/financial-document/validation-errors.md)
- [Overwrite financial document parties](https://api-docs.rightsline.com/entities/financial-document/overwrite-financial-document-parties.md)
- [Inventory](https://api-docs.rightsline.com/entities/inventory.md)
- [Create an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-create.md)
- [Retrieve an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-retrieve.md)
- [Update an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-update-1.md)
- [Delete an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-delete.md)
- [Retrieve inventory statuses](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-statuses.md)
- [Retrieve inventory workflow processes](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-processes.md)
- [Retrieve inventory draft templates](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-draft-templates.md)
- [Retrieve an inventory key art URL](https://api-docs.rightsline.com/entities/inventory/retrieve-an-inventory-key-art-url.md): Used to retrieve key art for an inventory item.
- [Update an inventory key art](https://api-docs.rightsline.com/entities/inventory/update-an-inventory-key-art.md)
- [Delete an inventory key art](https://api-docs.rightsline.com/entities/inventory/delete-an-inventory-key-art.md): Delete the key art for an inventory item.
- [Retrieve inventory audit history](https://api-docs.rightsline.com/entities/inventory/audit-history.md): Retrieve the audit history for an inventory record.
- [Switch inventory template](https://api-docs.rightsline.com/entities/inventory/switch-inventory-template.md): Switches the inventory record to a new template
- [Retrieve inventory validation errors](https://api-docs.rightsline.com/entities/inventory/validation-errors.md)
- [Overwrite inventory parties](https://api-docs.rightsline.com/entities/inventory/overwrite-inventory-parties.md)
- [Project](https://api-docs.rightsline.com/entities/project.md)
- [Create a project](https://api-docs.rightsline.com/entities/project/project-create.md)
- [Retrieve a project](https://api-docs.rightsline.com/entities/project/project-retrieve.md)
- [Update a project](https://api-docs.rightsline.com/entities/project/project-update.md)
- [Delete a project](https://api-docs.rightsline.com/entities/project/project-delete.md)
- [Retrieve project statuses](https://api-docs.rightsline.com/entities/project/retrieve-project-statuses.md)
- [Retrieve project workflow processes](https://api-docs.rightsline.com/entities/project/retrieve-project-processes.md)
- [Retrieve project draft templates](https://api-docs.rightsline.com/entities/project/retrieve-project-draft-templates.md)
- [Retrieve project audit history](https://api-docs.rightsline.com/entities/project/audit-history.md): Retrieve the audit history for an inventory record.
- [Switch project template](https://api-docs.rightsline.com/entities/project/switch-project-template.md): Switches the inventory record to a new template
- [Retrieve project validation errors](https://api-docs.rightsline.com/entities/project/validation-errors.md)
- [Overwrite project parties](https://api-docs.rightsline.com/entities/project/overwrite-deal-parties.md)
- [Job](https://api-docs.rightsline.com/entities/job.md)
- [Create a job](https://api-docs.rightsline.com/entities/job/job-create.md)
- [Retrieve a job](https://api-docs.rightsline.com/entities/job/job-retrieve.md)
- [Update a job](https://api-docs.rightsline.com/entities/job/job-update.md)
- [Delete a job](https://api-docs.rightsline.com/entities/job/job-delete.md)
- [Retrieve job statuses](https://api-docs.rightsline.com/entities/job/retrieve-job-statuses.md)
- [Retrieve job workflow processes](https://api-docs.rightsline.com/entities/job/retrieve-job-processes.md)
- [Retrieve job draft templates](https://api-docs.rightsline.com/entities/job/retrieve-job-draft-templates.md)
- [Retrieve job audit history](https://api-docs.rightsline.com/entities/job/audit-history.md): Retrieve the audit history for a job record.
- [Switch job template](https://api-docs.rightsline.com/entities/job/switch-job-template.md): Switches the job record to a new template
- [Retrieve job validation errors](https://api-docs.rightsline.com/entities/job/validation-errors.md)
- [Overwrite job parties](https://api-docs.rightsline.com/entities/job/overwrite-job-parties.md)
- [Right](https://api-docs.rightsline.com/entities/right.md)
- [Create a right](https://api-docs.rightsline.com/entities/right/right-create.md)
- [Retrieve a right](https://api-docs.rightsline.com/entities/right/right-retrieve.md)
- [Update a right](https://api-docs.rightsline.com/entities/right/right-update.md)
- [Delete a right](https://api-docs.rightsline.com/entities/right/right-delete.md)
- [Retrieve right statuses](https://api-docs.rightsline.com/entities/right/retrieve-right-statuses.md)
- [Retrieve right workflow processes](https://api-docs.rightsline.com/entities/right/retrieve-right-processes.md)
- [Retrieve right draft templates](https://api-docs.rightsline.com/entities/right/retrieve-right-draft-templates.md)
- [Retrieve relative rights profiles](https://api-docs.rightsline.com/entities/right/retrieve-relative-rights-profiles.md)
- [Execute relative rights profile](https://api-docs.rightsline.com/entities/right/execute-relative-rights-profile.md)
- [Retrieve right audit history](https://api-docs.rightsline.com/entities/right/audit-history.md): Retrieve the audit history for a right record.
- [Switch right template](https://api-docs.rightsline.com/entities/right/switch-right-template.md): Switches the right record to a new template
- [Retrieve right validation errors](https://api-docs.rightsline.com/entities/right/validation-errors.md)
- [Table](https://api-docs.rightsline.com/entities/table.md)
- [Create a table row](https://api-docs.rightsline.com/entities/table/tablerow-create.md)
- [Retrieve a table row](https://api-docs.rightsline.com/entities/table/tablerow-retrieve.md)
- [Update a table row](https://api-docs.rightsline.com/entities/table/tablerow-update.md)
- [Delete a table row](https://api-docs.rightsline.com/entities/table/tablerow-delete.md)
- [Retrieve table statuses](https://api-docs.rightsline.com/entities/table/retrieve-table-statuses.md)
- [Retrieve table workflow processes](https://api-docs.rightsline.com/entities/table/retrieve-table-processes.md)
- [Retrieve table draft templates](https://api-docs.rightsline.com/entities/table/retrieve-table-draft-templates.md)
- [Retrieve table audit history](https://api-docs.rightsline.com/entities/table/audit-history.md): Retrieve the audit history for a table record.
- [Switch table template](https://api-docs.rightsline.com/entities/table/switch-table-template.md): Switches the right record to a new template
- [Retrieve table validation errors](https://api-docs.rightsline.com/entities/table/validation-errors.md)
- [The relationship object](https://api-docs.rightsline.com/relationships/relationship-object.md)
- [Relationship types](https://api-docs.rightsline.com/relationships/relationship-types.md)
- [Create a relationship](https://api-docs.rightsline.com/relationships/relationship-create.md): A relationship between two entities can be created by populating the parentRelationship array when creating an entity, or by using the create relationship endpoint.
- [Delete a relationship](https://api-docs.rightsline.com/relationships/relationship-delete.md)
- [Create a party relationship](https://api-docs.rightsline.com/relationships/create-a-party-relationship.md)
- [Entity search](https://api-docs.rightsline.com/search/search-entity.md): Search for an entity or set of entities based on their characteristics.
- [Relationship search](https://api-docs.rightsline.com/search/search-rel.md): Search for a relationship between two entities.
- [Pagination](https://api-docs.rightsline.com/search/pagination.md): Search requests return paginated results.
- [Making paginated search requests](https://api-docs.rightsline.com/search/pagination/making-paginated-search-requests.md)
- [Sorting search responses](https://api-docs.rightsline.com/search/pagination/sorting-search-responses.md)
- [Search fields](https://api-docs.rightsline.com/search/search-fields.md)
- [Search functions](https://api-docs.rightsline.com/search/search-functions.md)
- [Single query functions](https://api-docs.rightsline.com/search/search-functions/single-query-functions.md)
- [Multi-query functions](https://api-docs.rightsline.com/search/search-functions/multi-query-functions.md)
- [$and](https://api-docs.rightsline.com/search/search-functions/multi-query-functions/and.md)
- [$or](https://api-docs.rightsline.com/search/search-functions/multi-query-functions/or.md)
- [$not](https://api-docs.rightsline.com/search/search-functions/multi-query-functions/not.md)
- [Join functions](https://api-docs.rightsline.com/search/search-functions/join-functions.md)
- [$join\_parent\_rel](https://api-docs.rightsline.com/search/search-functions/join-functions/join_parent_rel.md)
- [$join\_child\_rel](https://api-docs.rightsline.com/search/search-functions/join-functions/join_child_rel.md)
- [$join](https://api-docs.rightsline.com/search/search-functions/join-functions/join.md)
- [Searching for deleted entities or relationships](https://api-docs.rightsline.com/search/searching-for-deleted-entities-or-relationships.md)
- [Examples](https://api-docs.rightsline.com/search/examples.md)
- [Find financial document by parent financial document](https://api-docs.rightsline.com/search/examples/example-find-financial-document-by-parent-financial-document.md)
- [Search by template and status](https://api-docs.rightsline.com/search/examples/search-by-template-and-status.md): Use the below search on any of the /search endpoints to filter the results by a specific template and status.
- [Find catalog items on a deal](https://api-docs.rightsline.com/search/examples/find-catalog-items-on-a-deal.md)
- [Find rights on catalog item](https://api-docs.rightsline.com/search/examples/find-rights-on-catalog-item.md)
- [Find rights by child contact](https://api-docs.rightsline.com/search/examples/find-rights-by-child-contact.md)
- [Search for all records that don't have a value for a specific field](https://api-docs.rightsline.com/search/examples/search-for-all-records-that-dont-have-a-value-for-a-specific-field.md)
- [Search relationships, filtering by template of child record](https://api-docs.rightsline.com/search/examples/search-relationships-filtering-by-template-of-child-record.md)
- [Overview](https://api-docs.rightsline.com/batch/overview.md): Process multiple records with a single request using batch functionality.
- [Limitations](https://api-docs.rightsline.com/batch/overview/limitations.md)
- [Batch structure](https://api-docs.rightsline.com/batch/overview/batch-structure.md)
- [Batch methods](https://api-docs.rightsline.com/batch/overview/batch-methods.md)
- [Batch options](https://api-docs.rightsline.com/batch/overview/batch-options.md)
- [Batch statuses](https://api-docs.rightsline.com/batch/overview/batch-statuses.md)
- [Error handling](https://api-docs.rightsline.com/batch/overview/error-handling.md)
- [Create a batch](https://api-docs.rightsline.com/batch/create.md)
- [Retrieve a batch](https://api-docs.rightsline.com/batch/retrieve.md)
- [Overview](https://api-docs.rightsline.com/graphql/overview.md)
- [Entity](https://api-docs.rightsline.com/graphql/entity.md)
- [Parents](https://api-docs.rightsline.com/graphql/entity/parents.md)
- [Children](https://api-docs.rightsline.com/graphql/entity/children.md)
- [Characteristics](https://api-docs.rightsline.com/graphql/entity/characteristics.md)
- [Parties](https://api-docs.rightsline.com/graphql/entity/parties.md)
- [DateMath](https://api-docs.rightsline.com/graphql/entity/datemath.md)
- [Errors](https://api-docs.rightsline.com/graphql/errors.md)
- [Data default, aka Profiles](https://api-docs.rightsline.com/data-defaults/overview.md): Quickly create multiple records based on an existing series of records per char type.
- [Create a data default](https://api-docs.rightsline.com/data-defaults/create.md)
- [Retrieve data defaults](https://api-docs.rightsline.com/data-defaults/retrieve.md)
- [Apply data default](https://api-docs.rightsline.com/data-defaults/apply.md): This endpoint returns a batch id, you will need to use the batch GET endpoint to see the full results of this function.
- [Delete data default](https://api-docs.rightsline.com/data-defaults/retrieve-1.md)
- [Execute a workflow action](https://api-docs.rightsline.com/workflow/workflow-execute.md): Workflow actions can be executed on a specific entity of any type.
- [Execute document workflow action](https://api-docs.rightsline.com/workflow/execute-document-workflow-action.md): Execute a workflow action that creates a document.
- [Execute a workflow action with signature](https://api-docs.rightsline.com/workflow/workflow-execute-signature.md): Execute a workflow action that requires an E-Signature.
- [Get workflow actions](https://api-docs.rightsline.com/workflow/get-workflow-actions.md): Get the workflow actions for a particular workflow process.
- [Get workflow action details](https://api-docs.rightsline.com/workflow/get-workflow-action-details.md): Get the workflow action details for a particular workflow action.
- [Get workflow statuses](https://api-docs.rightsline.com/workflow/get-workflow-statuses.md): Get the workflow statuses for a particular workflow process.
- [Get workflow notifications](https://api-docs.rightsline.com/workflow/get-workflow-notifications.md): Get the workflow notifications for a particular workflow process.
- [Create a royalty](https://api-docs.rightsline.com/financial/create-a-royalty.md): The steps required to create a royalty.
- [Create a royalty set](https://api-docs.rightsline.com/financial/create-a-royalty/create-a-royalty-set.md)
- [Associate royalty set to deal](https://api-docs.rightsline.com/financial/create-a-royalty/associate-royalty-set-to-deal.md)
- [Associate royalty set to catalog](https://api-docs.rightsline.com/financial/create-a-royalty/associate-royalty-set-to-catalog.md)
- [Create royalty split](https://api-docs.rightsline.com/financial/create-a-royalty/create-royalty-split.md)
- [Associate royalty split to royalty set](https://api-docs.rightsline.com/financial/create-a-royalty/associate-royalty-split-to-royalty-set.md)
- [Associate contact to royalty split](https://api-docs.rightsline.com/financial/create-a-royalty/associate-contact-to-royalty-split.md)
- [Get amortization models](https://api-docs.rightsline.com/financial/get-amortization-models.md)
- [Calculate amortization](https://api-docs.rightsline.com/financial/calculate-amortization.md)
- [Get allocation models](https://api-docs.rightsline.com/financial/get-allocation-models.md)
- [Calculate allocations](https://api-docs.rightsline.com/financial/calculate-allocations.md)
- [Financial periods](https://api-docs.rightsline.com/financial/financial-periods.md): Financial Periods define a date range for a specific year.
- [Create financial period](https://api-docs.rightsline.com/financial/financial-periods/create-financial-period.md)
- [Get financial periods](https://api-docs.rightsline.com/financial/financial-periods/get-financial-periods.md)
- [Get financial periods settings](https://api-docs.rightsline.com/financial/financial-periods/get-financial-periods-settings.md)
- [Update financial period](https://api-docs.rightsline.com/financial/financial-periods/update-financial-period.md)
- [Update financial period settings](https://api-docs.rightsline.com/financial/financial-periods/update-financial-period-settings.md)
- [Close financial period](https://api-docs.rightsline.com/financial/financial-periods/close-financial-period.md)
- [Delete financial period](https://api-docs.rightsline.com/financial/financial-periods/delete-financial-period.md)
- [Lists](https://api-docs.rightsline.com/config/lists.md)
- [Retrieve master value list](https://api-docs.rightsline.com/config/lists/retrieve-master-value-list.md)
- [Add value to master list](https://api-docs.rightsline.com/config/lists/add-value-to-master-list.md): Add a new value to a master list of values.
- [Update value in master list](https://api-docs.rightsline.com/config/lists/update-value-in-master-list.md): Update a value in a master list of values.
- [Remove value from master list](https://api-docs.rightsline.com/config/lists/remove-value-from-master-list.md): Remove a value from a master list of values.
- [Retrieve pick list](https://api-docs.rightsline.com/config/lists/retrieve-pick-list.md): Retrieve pick lists or a pick list by ID.
- [Retrieve pick list presets](https://api-docs.rightsline.com/config/lists/retrieve-pick-list-presets.md): Retrieve all presets for a pick list by ID.
- [Add values to pick list](https://api-docs.rightsline.com/config/lists/add-values-to-pick-list.md)
- [Remove value from pick list](https://api-docs.rightsline.com/config/lists/remove-value-from-pick-list.md): Remove a value from a pick list.
- [Currency conversion](https://api-docs.rightsline.com/config/currency-conversion-sept-16.md): Specify the conversion rates between various currencies.
- [Create a currency conversion](https://api-docs.rightsline.com/config/currency-conversion-sept-16/currency-conversion-create.md)
- [Retrieve a currency conversion](https://api-docs.rightsline.com/config/currency-conversion-sept-16/currency-conversion-retrieve.md)
- [Retrieve all currency conversions](https://api-docs.rightsline.com/config/currency-conversion-sept-16/currency-conversions-retrieve-all.md)
- [Update a currency conversion](https://api-docs.rightsline.com/config/currency-conversion-sept-16/currency-conversion-update.md)
- [Delete a currency conversion](https://api-docs.rightsline.com/config/currency-conversion-sept-16/currency-conversion-delete.md)
- [Data types](https://api-docs.rightsline.com/config/data-types.md): The different data types that can specified for a characteristic
- [Alphanumeric text](https://api-docs.rightsline.com/config/data-types/alphanumeric-text.md): Configures either a dropdown or an input field.
- [Free text](https://api-docs.rightsline.com/config/data-types/alphanumeric-text/free-text.md): Alpha Numeric allows plain text of alphabetic or mixed numeric/alpha data to be entered into the text field. For example, a “Notes” field.
- [List of Values (LOVs)](https://api-docs.rightsline.com/config/data-types/alphanumeric-text/list-of-values-lovs.md): Lists of Values are sets of data that are pre-configured to be the only possible answers in a given field. These can be set up in a hierarchical or straight-line fashion.
- [Checkbox](https://api-docs.rightsline.com/config/data-types/checkbox.md): Allows a checkbox to appear for use as a Yes or Yes/No field.
- [Yes only](https://api-docs.rightsline.com/config/data-types/checkbox/yes-only.md): A Yes only checkbox can specified that will only toggle to Yes when checked and nothing when unchecked.
- [Date](https://api-docs.rightsline.com/config/data-types/date.md): Configures a date field, allows the user to enter a date into a text box or choose from a date picker
- [Email](https://api-docs.rightsline.com/config/data-types/email.md): Configures an input field to appear that the user can enter an input field
- [External Document](https://api-docs.rightsline.com/config/data-types/external-document.md): Configures a field to have a file dialog that the user can upload one or more files with
- [Four Digit Year](https://api-docs.rightsline.com/config/data-types/four-digit-year.md): Configures a input field to appear that allows a year to be entered
- [Internet Address](https://api-docs.rightsline.com/config/data-types/internet-address.md): Configures an input field to appear for a URL.
- [Money](https://api-docs.rightsline.com/config/data-types/money.md): Configures a dropdown and an input that allows a currency amount to be entered
- [Number](https://api-docs.rightsline.com/config/data-types/number.md): Configures a number input field
- [Percentage](https://api-docs.rightsline.com/config/data-types/number/percentage.md): Similar to Number, input field will represent a percent.
- [SMPTETimeCode](https://api-docs.rightsline.com/config/data-types/smptetimecode.md): Configures an input field for a timecode
- [Others](https://api-docs.rightsline.com/config/data-types/others.md): A few other data types that are available but not entirely built out.
- [Templates](https://api-docs.rightsline.com/config/templates.md)
- [Fields](https://api-docs.rightsline.com/config/fields.md)
- [Overview](https://api-docs.rightsline.com/date-math/date-math-overview.md)
- [The date math object](https://api-docs.rightsline.com/date-math/date-math-object.md): The date math object structure.
- [Create date math](https://api-docs.rightsline.com/date-math/datemath-create.md)
- [Retrieve date math](https://api-docs.rightsline.com/date-math/date-math-retrieve.md)
- [Update date math](https://api-docs.rightsline.com/date-math/update-date-math.md)
- [Delete date math](https://api-docs.rightsline.com/date-math/delete-date-math.md)
- [Date alerts](https://api-docs.rightsline.com/alerts/date-alerts.md)
- [Retrieve date alerts](https://api-docs.rightsline.com/alerts/date-alerts/date-alerts-retrieve.md)
- [Overview](https://api-docs.rightsline.com/avails/avails-overview.md)
- [Get dimension data](https://api-docs.rightsline.com/avails/avails-dimension-data.md)
- [Get reason unavailable list](https://api-docs.rightsline.com/avails/avails-reason-unavailable-list.md)
- [Get availability](https://api-docs.rightsline.com/avails/avails-get-availability.md)
- [Availability request vs Rights Explorer](https://api-docs.rightsline.com/avails/avails-get-availability/availability-request-vs-rights-explorer.md)
- [Get unavailable reasons](https://api-docs.rightsline.com/avails/get-unavailable-reasons.md)
- [Get available catalog items](https://api-docs.rightsline.com/avails/available-catalog-items.md)
- [Is catalog item available](https://api-docs.rightsline.com/avails/avails-is-catalog-item-available.md)
- [Catalog last calculated](https://api-docs.rightsline.com/avails/catalog-last-calculated.md)
- [Get Snapshots](https://api-docs.rightsline.com/avails/avails-dimension-data-1.md)
- [Get Snapshot Details](https://api-docs.rightsline.com/avails/avails-dimension-data-2.md)
- [Delete Snapshot](https://api-docs.rightsline.com/avails/avails-dimension-data-3.md)
- [Get applications](https://api-docs.rightsline.com/users/get-applications.md)
- [Get roles](https://api-docs.rightsline.com/users/get-roles.md)
- [Get user](https://api-docs.rightsline.com/users/get-user.md)
- [Create a user](https://api-docs.rightsline.com/users/create-a-user.md): Create a user with Rightsline access.
- [Update user messaging](https://api-docs.rightsline.com/users/update-user-messaging.md)
- [Apply user applications](https://api-docs.rightsline.com/users/apply-user-applications.md)
- [Apply user roles](https://api-docs.rightsline.com/users/apply-user-roles.md)
- [Delete user](https://api-docs.rightsline.com/users/delete-user.md)
- [Get user identity role](https://api-docs.rightsline.com/users/get-user-identity-role.md)
- [Get user activity policy](https://api-docs.rightsline.com/users/get-user-activity-policy.md)
- [Overview](https://api-docs.rightsline.com/sso/overview.md): The three basic endpoints for SSO configuration.
- [Retrieve SSO configuration](https://api-docs.rightsline.com/sso/sso-retrieve.md)
- [Update SSO configuration](https://api-docs.rightsline.com/sso/sso-update.md)
- [Delete SSO configuration](https://api-docs.rightsline.com/sso/sso-delete.md)
- [Catalog metadata](https://api-docs.rightsline.com/starter-packs/catalog-metadata.md)
- [Availability feed](https://api-docs.rightsline.com/starter-packs/availability-feed.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://api-docs.rightsline.com/master.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.