Search songs

get

https://{tenant}.onechurchsoftware.com/api/songs

Retrieve a list of songs matching the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

title

string

Include songs which contain this text in the title.

category

string

Comma-delimited list of category ids. Use -1 to include songs without a category. Values come from /api/property_values/song_categories/values.

authors

string

Include songs which contain this text in the authors.

ccli

string

Include songs whose CCLI number contains this text.

arrangements.start

double

Include songs with at least this many arrangements.

arrangements.end

double

Include songs with at most this many arrangements.

lastUsed.start

date-time

Include songs last scheduled after this date and time (UTC).

lastUsed.end

date-time

Include songs last scheduled before this date and time (UTC).

filter

string

Free text search across the song title, CCLI number, category, notes, authors, and copyright.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK