Skip to main content

​
List Projects

Returns all projects accessible to the authenticated token.
Organization-scoped tokens return all projects. Project-scoped tokens return only their assigned project. See Token Scope for details.

​
Request

GET /v1/projects

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <token>

​
Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Record Label Ltd",
      "created_at": "2025-01-15T10:30:00Z",
      "organization_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890"
    }
  ]
}

​
Example

curl https://api.royaltyport.com/v1/projects \
  -H "Authorization: Bearer rp_your_token_here"

​
Get Project

Returns a single project by ID.

​
Request

GET /v1/projects/{project_id}

​
Path Parameters

ParameterTypeRequiredDescription
project_idUUIDYesThe project ID

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <token>

​
Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Record Label Ltd",
    "created_at": "2025-01-15T10:30:00Z",
    "organization_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890"
  }
}

​
Errors

StatusDescription
404Project not found or does not belong to the token’s organization

​
Example

curl https://api.royaltyport.com/v1/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer rp_your_token_here"

​
Search Project

Search across all resources in a project — contracts, entities, artists, writers, recordings, and compositions.

​
Request

GET /v1/projects/{project_id}/search

​
Path Parameters

ParameterTypeRequiredDescription
project_idUUIDYesThe project ID

​
Query Parameters

ParameterTypeRequiredDescription
qstringYesSearch query (1–500 characters)

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <token> — must be scoped to the requested project

​
Response

{
  "data": [
    {
      "type": "contract",
      "id": "contract-123",
      "name": "Distribution Agreement - Sony Music",
      "score": 0.95
    },
    {
      "type": "artist",
      "id": "artist-456",
      "name": "Sony Music Entertainment",
      "score": 0.82
    }
  ]
}

​
Errors

StatusDescription
400Missing or invalid q query parameter
403Token is not scoped to the requested project

​
Example

curl "https://api.royaltyport.com/v1/projects/a1b2c3d4-.../search?q=Sony%20Music" \
  -H "Authorization: Bearer rp_your_token_here"