Get a sound effects category by id

GET 
/v0/sound-effects/categories/:categoryId

The category details endpoint contains info on the requested sound effects category.

The purpose of this endpoint is to be able to validate that an individual object exists in the API if it was cached by the client.

Request

Path Parameters

categoryId uuidrequired

Category id

Responses

200

Category with related parent and children categories

application/json

Schema

Schema

id uuidrequired
name stringrequired

images

object

default stringnullable

L stringnullable

M stringnullable

S stringnullable

XS stringnullable

parent

object

id uuidrequired

name stringrequired

children

object[]

Array [

id uuidrequired

name stringrequired

]

Example (from schema)

{
  "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"
  },
  "children": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ]
}

Example

{
  "id": "eb0852a4-3d3a-401a-abbc-eb5ea9b477c9",
  "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": "e69d761a-6609-4185-9fdb-95ff68e77c63",
    "name": "Crowds"
  },
  "children": [
    {
      "id": "4aa156c2-9565-4920-b8d7-2c9b88cfb373",
      "name": "Claps"
    }
  ]
}

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"
}

404

Category was not found.

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": "Category was not found"
}

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...