Get a list of all sound effects categories

GET 
/v0/sound-effects/categories

The sound effects categories endpoint allows you to get a list of all sound effects categories.

You can then browse the sound effects catalog based on categories like "Applause" or "Crowds".

Some sound effect categories have cover art that you can use in your interface. You can choose to display all categories, or choose type “featured” to only show the categories that are chosen by our curation team.

Request

Query Parameters

type string
Possible values: [all, featured]
Category type
Default value: all
offset int32

Index of the entry track in the response

limit any

Max number of entries returned in the response, default 50

Responses

200

Sound effects category list with related parent category. You can see the parent-child relationship in the response.

application/json

Schema

Schema

categories

object[]

required

Array [

id uuidrequired

name stringrequired

images

object

default stringnullable

L stringnullable

M stringnullable

S stringnullable

XS stringnullable

parent

object

id uuidrequired

name stringrequired

]

pagination

object

required

page int32required

limit int32required

offset int32

links

object

required

next stringnullable

prev stringnullable

Example (from schema)

{
  "categories": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "images": {
        "default": "string",
        "L": "string",
        "M": "string",
        "S": "string",
        "XS": "string"
      },
      "parent": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "offset": 0
  },
  "links": {
    "next": "string",
    "prev": "string"
  }
}

Example

{
  "categories": [
    {
      "id": "6daa4e2d-cb59-448e-8f58-5c415673f9af",
      "name": "Applause",
      "images": {
        "default": "https://image.url?w=300&h=300&fit=fill&q=90&fm=jpg",
        "L": "https://image.url?w=1050&h=1050&fit=fill&q=90&fm=jpg",
        "M": "https://image.url?w=600&h=600&fit=fill&q=90&fm=jpg",
        "S": "https://image.url?w=300&h=300&fit=fill&q=90&fm=jpg",
        "XS": "https://image.url?w=128&h=128&fit=fill&q=90&fm=jpg"
      },
      "parent": {
        "id": "c98262eb-b9b7-40a1-af56-f8381bb0565b",
        "name": "Crowds"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 10,
    "offset": 10
  },
  "links": {
    "next": "/v0/sound-effects/categories?limit=10&offset=20",
    "prev": "/v0/sound-effects/categories?limit=10&offset=0"
  }
}

400

Bad request.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Bad request"
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Invalid credentials"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Rate limit exceeded"
}

Loading...