Category

DOCUMENTATION (1.0.0)

Partner APIs to embed Audicin in your application

Download OpenAPI description
b2b_portal_documentation.json
b2b_portal_documentation.yaml
Overview
URL https://audicin.com
TEAM developers@audicin.com
License Proprietary License
 Terms of Service
Languages
Servers
Production server
https://api.partner.audicin.com/api/

Artist

Operations

Category

Operations

get/categories

Request

Query
sortstring

Sort by attributes ascending (asc) or descending (desc)

pagination[withCount]boolean

Return page/pageSize (default: true)

pagination[page]integer

Page number (default: 0)

pagination[pageSize]integer

Page size (default: 25)

pagination[start]integer

Offset value (default: 0)

pagination[limit]integer

Number of entities to return (default: 25)

fieldsstring

Fields to return (ex: title,author)

populatestring

Relations to return

filtersobject

Filters to apply

localestring

Locale to apply

curl -i -X GET \
  'https://api.partner.audicin.com/api/categories?fields=string&locale=string&pagination%5Blimit%5D=0&pagination%5Bpage%5D=0&pagination%5BpageSize%5D=0&pagination%5Bstart%5D=0&pagination%5BwithCount%5D=true&populate=string&sort=string' \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects(Category)
metaobject
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "pagination": { … }
  }
}

get/categories/{id}

Request

Path
idnumberrequired
curl -i -X GET \
  'https://api.partner.audicin.com/api/categories/{id}' \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>'

Responses

OK

Bodyapplication/json
dataobject(Category)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "documentId": "string",
    "name": "string",
    "type": "main",
    "songs": [ … ],
    "playlists": [ … ],
    "tenant": { … },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "publishedAt": "2019-08-24T14:15:22Z",
    "createdBy": { … },
    "updatedBy": { … },
    "locale": "string",
    "localizations": [ … ]
  },
  "meta": {}
}

Playlist

Operations

Song

Operations